Versions in this module Expand all Collapse all v1 v1.4.4 Apr 2, 2024 v1.4.3 Apr 2, 2024 Changes in this version + func ColonPath(path string) string + func DirFS(dir string, fsys fs.FS) http.FileSystem + func UIHandler(prefix, uri string, autoDomain bool) http.Handler + func UIPatterns(prefix string) []string + type API struct + BasePath string + Definitions map[string]Object + Host string + Info Info + Paths map[string]*Endpoints + Schemes []string + Security *SecurityRequirement + SecurityDefinitions map[string]SecurityScheme + Swagger string + Tags []Tag + func New(options ...Option) *API + func (a *API) AddEndpoint(es ...*Endpoint) + func (a *API) AddEndpointFunc(fs ...func(*API)) + func (a *API) AddOptions(options ...Option) + func (a *API) AddTag(name, description string) + func (a *API) Clone() *API + func (a *API) Handler() http.HandlerFunc + func (a *API) Walk(callback func(path string, endpoint *Endpoint)) + func (a *API) WithGroup(prefixPath string) *API + func (a *API) WithTag(name, description string) *API + func (a *API) WithTags(tags ...Tag) *API + type Contact struct + Email string + type Endpoint struct + Consumes []string + Deprecated bool + Description string + Handler interface{} + Method string + OperationID string + Parameters []Parameter + Path string + Produces []string + Responses map[string]Response + Security *SecurityRequirement + Summary string + Tags []string + func (e *Endpoint) BuildOperationID() + type Endpoints struct + Connect *Endpoint + Delete *Endpoint + Get *Endpoint + Head *Endpoint + Options *Endpoint + Patch *Endpoint + Post *Endpoint + Put *Endpoint + Trace *Endpoint + func (e *Endpoints) ServeHTTP(w http.ResponseWriter, req *http.Request) + func (e *Endpoints) Walk(fn func(endpoint *Endpoint)) + type Header struct + Description string + Format string + Type types.ParameterType + type Info struct + Contact *Contact + Description string + License License + TermsOfService string + Title string + Version string + type Items struct + Format string + Ref string + Type string + type License struct + Name string + URL string + type Object struct + Description string + Format string + GoType reflect.Type + IsArray bool + Name string + Properties map[string]Property + Required []string + Type string + type Option func(api *API) + type Parameter struct + Default string + Description string + Format string + In string + Name string + Required bool + Schema *Schema + Type types.ParameterType + type Property struct + Description string + Enum []string + Example string + Format string + GoType reflect.Type + Items *Items + Ref string + Type string + type Response struct + Description string + Headers map[string]Header + Schema *Schema + type Schema struct + Items *Items + Prototype interface{} + Ref string + Type string + func MakeSchema(prototype interface{}) *Schema + type SecurityRequirement struct + DisableSecurity bool + Requirements []map[string][]string + func (s *SecurityRequirement) MarshalJSON() ([]byte, error) + type SecurityScheme struct + AuthorizationURL string + Description string + Flow string + In string + Name string + Scopes map[string]string + TokenURL string + Type string + type Tag struct + Description string + Docs *TagDocs + Name string + type TagDocs struct + Description string + URL string