spec

Documentation

Index

• type Endpoint
• type Route
• type RouteGroup
  • func NewRouteGroup(router *Router, prefix string) *RouteGroup
  • func (r *RouteGroup) Register(handlers ...pyrin.Handler)
• type Router
  • func (r *Router) AddRoute(route Route)
  • func (r *Router) Group(prefix string) pyrin.Group
• type Server
  • func GenerateSpec(routes []Route) (*Server, error)
• type Type
• type TypeField

Types

type Endpoint

type Endpoint struct {
	Name            string   `json:"name"`
	Method          string   `json:"method"`
	Path            string   `json:"path"`
	ErrorTypes      []string `json:"errorTypes"`
	ResponseType    string   `json:"responseType"`
	BodyType        string   `json:"bodyType"`
	RequireFormData bool     `json:"requireFormData"`
}

type Route

type Route struct {
	Name        string
	Path        string
	Method      string
	ErrorTypes  []pyrin.ErrorType
	Data        any
	Body        any
	RequireForm bool
}

type RouteGroup

type RouteGroup struct {
	Router *Router
	Prefix string
}

func NewRouteGroup

func NewRouteGroup(router *Router, prefix string) *RouteGroup

func (*RouteGroup) Register

func (r *RouteGroup) Register(handlers ...pyrin.Handler)

type Router

type Router struct {
	Routes []Route
}

func (*Router) AddRoute

func (r *Router) AddRoute(route Route)

func (*Router) Group

func (r *Router) Group(prefix string) pyrin.Group

type Server

type Server struct {
	Types     []Type     `json:"types"`
	Endpoints []Endpoint `json:"endpoints"`
}

func GenerateSpec

func GenerateSpec(routes []Route) (*Server, error)

type Type

type Type struct {
	Name   string      `json:"name"`
	Extend string      `json:"extend"`
	Fields []TypeField `json:"fields"`
}

type TypeField

type TypeField struct {
	Name string `json:"name"`
	Type string `json:"type"`
	Omit bool   `json:"omit"`
}