swag

Apr 7, 2024

Changes in this version

type Object

+ AdditionalProperties *Property

+ Items *Property

type Property

+ AdditionalProperties *Property

Oct 18, 2022

Changes in this version

type API

+ func (a *API) AddOptions(options ...Option)

+ func (a *API) WithGroup(prefixPath string) *API

+ func (a *API) WithTag(name, description string) *API

type Endpoint

+ func (e *Endpoint) BuildOperationID()

Apr 20, 2022

Changes in this version

type API

+ func (a *API) Clone() *API

Apr 19, 2022

retracted

Changes in this version

+ const TypeArray

+ const TypeBoolean

+ const TypeInteger

+ const TypeNumber

+ const TypeString

+ 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 (a *API) AddEndpoint(es ...*Endpoint)

+ func (a *API) AddEndpointFunc(fs ...func(*API))

+ func (a *API) AddTag(name, description string)

+ func (a *API) Handler() http.HandlerFunc

+ func (a *API) Walk(callback func(path string, endpoints *Endpoint))

+ 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

type Endpoints

+ 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 string

+ 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

+ 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 BasePathOption(v string) Option

+ func ContactEmailOption(v string) Option

+ func DescriptionOption(v string) Option

+ func EndpointsOption(endpoints ...*Endpoint) Option

+ func HostOption(v string) Option

+ func LicenseOption(name, url string) Option

+ func SchemesOption(v ...string) Option

+ func SecurityOption(scheme string, scopes ...string) Option

+ func SecuritySchemeOption(name string, scheme *SecurityScheme) Option

+ func TermsOfServiceOption(v string) Option

+ func TitleOption(v string) Option

+ func VersionOption(v string) Option

+ type Parameter struct

+ Default string

+ Description string

+ Format string

+ In string

+ Name string

+ Required bool

+ Schema *Schema

+ Type string

+ 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

+ AuthorizationURL string

+ Description string

+ Flow string

+ In string

+ Name string

+ Scopes map[string]string

+ TokenURL string

+ Type string

+ func APIKeySecurity(name, in string) *SecurityScheme

+ func BasicSecurity() *SecurityScheme

+ func OAuth2Security(flow, authorizationURL, tokenURL string) *SecurityScheme

type Tag

+ Description string

+ Docs *TagDocs

+ Name string

+ type TagDocs struct

+ Description string

+ URL string

Feb 23, 2021

Changes in this version

+ func RegisterMux(router swagger.RouteInterface, url string)

Oct 29, 2020

Changes in this version

+ func ColonPath(path string) string

+ func New(options ...Option) *swagger.API

+ type Builder struct

+ API *swagger.API

+ type Option func(builder *Builder)

+ func BasePath(v string) Option

+ func ContactEmail(v string) Option

+ func Description(v string) Option

+ func Endpoints(endpoints ...*swagger.Endpoint) Option

+ func Host(v string) Option

+ func License(name, url string) Option

+ func Schemes(v ...string) Option

+ func Security(scheme string, scopes ...string) Option

+ func SecurityScheme(name string, options ...swagger.SecuritySchemeOption) Option

+ func Tag(name, description string, options ...TagOption) Option

+ func TermsOfService(v string) Option

+ func Title(v string) Option

+ func Version(v string) Option

+ type TagOption func(tag *swagger.Tag)

+ func TagDescription(v string) TagOption

+ func TagURL(v string) TagOption