option

Documentation

Index

• func BasePath(v string) swag.Option
• func ContactEmail(v string) swag.Option
• func Description(v string) swag.Option
• func Endpoints(endpoints ...*swag.Endpoint) swag.Option
• func Host(v string) swag.Option
• func License(name, url string) swag.Option
• func Schemes(v ...string) swag.Option
• func Security(scheme string, scopes ...string) swag.Option
• func SecurityScheme(name string, options ...SecuritySchemeOption) swag.Option
• func Tag(name, description string, options ...TagOption) swag.Option
• func TermsOfService(v string) swag.Option
• func Title(v string) swag.Option
• func Version(v string) swag.Option
• type SecuritySchemeOption
  • func APIKeySecurity(name, in string) SecuritySchemeOption
  • func BasicSecurity() SecuritySchemeOption
  • func BearerAuth(name, in string) SecuritySchemeOption
  • func OAuth2Scope(scope, description string) SecuritySchemeOption
  • func OAuth2Security(flow, authorizationURL, tokenURL string) SecuritySchemeOption
  • func SecuritySchemeDescription(description string) SecuritySchemeOption
• type TagOption
  • func TagDescription(v string) TagOption
  • func TagURL(v string) TagOption

Functions

func BasePath

func BasePath(v string) swag.Option

BasePath sets basePath

func ContactEmail

func ContactEmail(v string) swag.Option

ContactEmail sets info.contact.email

func Description

func Description(v string) swag.Option

Description sets info.description

func Endpoints

func Endpoints(endpoints ...*swag.Endpoint) swag.Option

Endpoints allows the endpoints to be added dynamically to the Api

func Host

func Host(v string) swag.Option

Host specifies the host field

func License

func License(name, url string) swag.Option

License sets both info.license.name and info.license.url

func Schemes

func Schemes(v ...string) swag.Option

Schemes sets the scheme

func Security

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

Security sets a default security scheme for all endpoints in the API.

func SecurityScheme

func SecurityScheme(name string, options ...SecuritySchemeOption) swag.Option

SecurityScheme creates a new security definition for the API.

func Tag

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

Tag adds a tag to the swagger api

func TermsOfService

func TermsOfService(v string) swag.Option

TermsOfService sets info.termsOfService

func Title

func Title(v string) swag.Option

Title sets info.title

func Version

func Version(v string) swag.Option

Version sets info.version

Types

type SecuritySchemeOption

type SecuritySchemeOption func(securityScheme *swag.SecurityScheme)

SecuritySchemeOption provides additional customizations to the SecurityScheme.

func APIKeySecurity

func APIKeySecurity(name, in string) SecuritySchemeOption

APIKeySecurity defines a security scheme for API key authentication. "in" is the location of the API key (query or header). "name" is the name of the header or query parameter to be used.

func BasicSecurity

func BasicSecurity() SecuritySchemeOption

BasicSecurity defines a security scheme for HTTP Basic authentication.

func BearerAuth

func BearerAuth(name, in string) SecuritySchemeOption

BearerAuth defines a security scheme for Bearer authentication. "in" is the location of the token (query or header). "name" is the name of the header or query parameter to be used.

func OAuth2Scope

func OAuth2Scope(scope, description string) SecuritySchemeOption

OAuth2Scope adds a new scope to the security scheme.

func OAuth2Security

func OAuth2Security(flow, authorizationURL, tokenURL string) SecuritySchemeOption

OAuth2Security defines a security scheme for OAuth2 authentication. Flow can be one of implicit, password, application, or accessCode.

func SecuritySchemeDescription

func SecuritySchemeDescription(description string) SecuritySchemeOption

SecuritySchemeDescription sets the security scheme's description.

type TagOption

type TagOption func(tag *swag.Tag)

TagOption provides additional customizations to the #Tag option

func TagDescription

func TagDescription(v string) TagOption

TagDescription sets externalDocs.description on the tag field

func TagURL

func TagURL(v string) TagOption

TagURL sets externalDocs.url on the tag field