reflector

Documentation

Index

• func BuildOpenAPIRoute(list []ConvertedHandler) map[string]spec.PathItem
• func Register(mux *mux.MethodServeMux, swagger *spec.Swagger, prefix string, ...) error
• func SchemaOfType(t reflect.Type) *spec.Schema
• type Argv
• type ConvertedHandler
  • func RegisterController(prefix string, parents []string, controller any) ([]ConvertedHandler, error)

Functions

func BuildOpenAPIRoute

func BuildOpenAPIRoute(list []ConvertedHandler) map[string]spec.PathItem

func Register

func Register(mux *mux.MethodServeMux, swagger *spec.Swagger, prefix string, parents []string, controller any) error

func SchemaOfType

func SchemaOfType(t reflect.Type) *spec.Schema

Types

type Argv

type Argv struct {
	Loc  argloc
	Typ  reflect.Type
	Name string // name in path, query, header, form
}

type ConvertedHandler

type ConvertedHandler struct {
	Method   string
	Path     string
	Desc     string // openapi description
	Resource string // openapi resource name
	ReqArgs  []Argv
	RespArgs []Argv
	Handler  http.Handler
}

func RegisterController

func RegisterController(prefix string, parents []string, controller any) ([]ConvertedHandler, error)