Versions in this module Expand all Collapse all v0 v0.1.0 Feb 15, 2026 Changes in this version + type API struct + DefaultSecurity []model.SecurityRequirement + Extensions map[string]any + ExternalDocs *model.ExternalDocs + Info model.Info + SchemaPrefix string + SecuritySchemes map[string]*model.SecurityScheme + Servers []model.Server + StrictDownlevel bool + TagConfig config.TagConfig + Tags []model.Tag + ValidateSpec bool + Version string + func NewAPI(opts ...Option) *API + func (a *API) Generate(ctx context.Context, ops ...Operation) (*Result, error) + type OAuth2Flow struct + AuthorizationURL string + RefreshURL string + Scopes map[string]string + TokenURL string + Type OAuthFlowType + type OAuthFlowType string + const FlowAuthorizationCode + const FlowClientCredentials + const FlowImplicit + const FlowPassword + type Operation struct + Method string + Path string + func DELETE(path string, opts ...OperationDocOption) Operation + func GET(path string, opts ...OperationDocOption) Operation + func HEAD(path string, opts ...OperationDocOption) Operation + func OPTIONS(path string, opts ...OperationDocOption) Operation + func PATCH(path string, opts ...OperationDocOption) Operation + func POST(path string, opts ...OperationDocOption) Operation + func PUT(path string, opts ...OperationDocOption) Operation + func TRACE(path string, opts ...OperationDocOption) Operation + type OperationDocOption func(*operationDoc) + func WithConsumes(contentTypes ...string) OperationDocOption + func WithDeprecated() OperationDocOption + func WithDescription(s string) OperationDocOption + func WithOperationExtension(key string, value any) OperationDocOption + func WithOperationID(id string) OperationDocOption + func WithOptions(opts ...OperationDocOption) OperationDocOption + func WithProduces(contentTypes ...string) OperationDocOption + func WithRequest(req any, examples ...example.Example) OperationDocOption + func WithResponse(status int, resp any, examples ...example.Example) OperationDocOption + func WithSecurity(scheme string, scopes ...string) OperationDocOption + func WithSummary(s string) OperationDocOption + func WithTags(tags ...string) OperationDocOption + type Option func(*API) + func WithAPIKey(name, paramName string, in ParameterLocation, desc string) Option + func WithBearerAuth(name, desc string) Option + func WithContact(name, url, email string) Option + func WithDefaultSecurity(scheme string, scopes ...string) Option + func WithExtension(key string, value any) Option + func WithExternalDocs(url, description string) Option + func WithInfoDescription(desc string) Option + func WithInfoExtension(key string, value any) Option + func WithInfoSummary(summary string) Option + func WithInfoTitle(title string) Option + func WithInfoVersion(version string) Option + func WithLicense(name, url string) Option + func WithLicenseIdentifier(name, identifier string) Option + func WithOAuth2(name, desc string, flows ...OAuth2Flow) Option + func WithOpenIDConnect(name, url, desc string) Option + func WithSchemaPrefix(prefix string) Option + func WithServer(url string, opts ...ServerOption) Option + func WithStrictDownlevel(strict bool) Option + func WithTag(name, desc string) Option + func WithTagConfig(cfg config.TagConfig) Option + func WithTermsOfService(url string) Option + func WithValidation(enabled bool) Option + func WithVersion(version string) Option + type ParameterLocation string + const InCookie + const InHeader + const InQuery + type Result struct + JSON []byte + Warnings debug.Warnings + type SecurityReq struct + Scheme string + Scopes []string + type ServerOption func(*model.Server) + func WithServerDescription(desc string) ServerOption + func WithServerExtension(key string, value any) ServerOption + func WithServerVariable(name, defaultValue string, enum []string, description string) ServerOption
Go to main page