package
0.0.0-20211121152213-2400d945f125
Repository: https://github.com/myml/swag.git
Documentation: pkg.go.dev
# Packages
No description provided by the author
# Functions
APIKeySecurity defines a security scheme for API key authentication.
BasicSecurity defines a security scheme for HTTP Basic authentication.
MakeSchema takes struct or pointer to a struct and returns a Schema instance suitable for use by the swagger doc.
OAuth2Scope adds a new scope to the security scheme.
OAuth2Security defines a security scheme for OAuth2 authentication.
SecuritySchemeDescription sets the security scheme's description.
# Structs
API provides the top level encapsulation for the swagger definition.
Contact represents the contact entity from the swagger definition; used by Info.
Docs represents tag docs from the swagger definition.
Endpoint represents an endpoint from the swagger doc.
Endpoints represents all the swagger endpoints associated with a particular path.
Header represents a response header.
Info represents the info entity from the swagger definition.
Items represents items from the swagger doc.
License represents the license entity from the swagger definition; used by Info.
Object represents the object entity from the swagger definition.
Parameter represents a parameter from the swagger doc.
Property represents the property entity from the swagger definition.
Response represents a response from the swagger doc.
Schema represents a schema from the swagger doc.
No description provided by the author
SecurityScheme represents a security scheme from the swagger definition.
Tag represents a swagger tag.
# Type aliases
SecuritySchemeOption provides additional customizations to the SecurityScheme.