doc

Documentation

Index

• func Doc(basePath, env string, opts ...Opts) http.HandlerFunc
• type Opts
• type RouteGen
• type RouteGroup
• type RouteInfos

Functions

func Doc

func Doc(basePath, env string, opts ...Opts) http.HandlerFunc

Types

type Opts

type Opts func(*swaggerConfig)

type RouteGen

type RouteGen interface {
	GetRouteInfos() []RouteInfos
}

type RouteGroup

type RouteGroup struct {
	GroupName string `json:"name"`
}

type RouteInfos

type RouteInfos struct {
	Method     string `json:"method"`      //  method
	Path       string `json:"path"`        //  path
	BasePath   string `json:"base_path"`   //  BasePath
	HandlerFun string `json:"handler_fun"` //  handlerFun
	Summary    string `json:"summary"`     //  Summary
	Public     bool   `json:"public"`      //  is public router
	RouteGroup
}