spec

Documentation

Index

• type ApiEndpoint
• type ApiRoute
• type FormApiEndpoint
• type FormApiRoute
• type NormalEndpoint
• type NormalRoute
• 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 ApiEndpoint

type ApiEndpoint struct {
	Name         string `json:"name"`
	Method       string `json:"method"`
	Path         string `json:"path"`
	ResponseType string `json:"responseType"`
	BodyType     string `json:"bodyType"`
}

type ApiRoute

type ApiRoute struct {
	Name         string
	Path         string
	Method       string
	ErrorTypes   []pyrin.ErrorType
	ResponseType any
	BodyType     any
}

type FormApiEndpoint

type FormApiEndpoint struct {
	Name         string `json:"name"`
	Method       string `json:"method"`
	Path         string `json:"path"`
	ResponseType string `json:"responseType"`
	BodyType     string `json:"bodyType"`
}

type FormApiRoute

type FormApiRoute struct {
	Name         string
	Path         string
	Method       string
	ErrorTypes   []pyrin.ErrorType
	ResponseType any
	Spec         pyrin.FormSpec
}

type NormalEndpoint

type NormalEndpoint struct {
	Name   string `json:"name"`
	Method string `json:"method"`
	Path   string `json:"path"`
}

type NormalRoute

type NormalRoute struct {
	Name   string
	Path   string
	Method string
}

type Route

type Route interface {
	// contains filtered or unexported methods
}

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 {
	ErrorTypes       []string          `json:"errorTypes"`
	Types            []Type            `json:"types"`
	ApiEndpoints     []ApiEndpoint     `json:"apiEndpoints"`
	FormApiEndpoints []FormApiEndpoint `json:"formApiEndpoints"`
	NormalEndpoints  []NormalEndpoint  `json:"normalEndpoints"`
}

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"`
}