spec

Aug 12, 2025

Changes in this version

type Router

+ With func(opts ...option.GroupOption) Router

Aug 10, 2025

Changes in this version

type Generator

+ DocsHandlerFunc func() http.HandlerFunc

+ SpecHandlerFunc func() http.HandlerFunc

Aug 9, 2025

Changes in this version

type Route

+ Method func(method string) Route

+ Path func(path string) Route

type Router

+ NewRoute func(opts ...option.OperationOption) Route

Jul 31, 2025

Changes in this version

type Generator

+ MarshalJSON func() ([]byte, error)

+ MarshalYAML func() ([]byte, error)

Jul 31, 2025

Changes in this version

type Generator

+ func NewRouter(opts ...option.OpenAPIOption) *Generator

+ func (g *Generator) Group(pattern string, opts ...option.GroupOption) Router

+ func (g *Generator) Route(pattern string, fn func(router Router), opts ...option.GroupOption) Router

+ func (g *Generator) Use(opts ...option.GroupOption) Router

+ type Route interface

+ With func(opts ...option.OperationOption) Route

+ type Router interface

+ Add func(method, path string, opts ...option.OperationOption) Route

+ Delete func(path string, opts ...option.OperationOption) Route

+ Get func(path string, opts ...option.OperationOption) Route

+ Group func(pattern string, opts ...option.GroupOption) Router

+ Head func(path string, opts ...option.OperationOption) Route

+ Options func(path string, opts ...option.OperationOption) Route

+ Patch func(path string, opts ...option.OperationOption) Route

+ Post func(path string, opts ...option.OperationOption) Route

+ Put func(path string, opts ...option.OperationOption) Route

+ Route func(pattern string, fn func(router Router), opts ...option.GroupOption) Router

+ Trace func(path string, opts ...option.OperationOption) Route

+ Use func(opts ...option.GroupOption) Router

Jul 31, 2025

Changes in this version

type Generator

+ func (g *Generator) Add(method, path string, opts ...option.OperationOption)

+ func (g *Generator) Config() *openapi.Config

+ func (g *Generator) Delete(path string, opts ...option.OperationOption)

+ func (g *Generator) Get(path string, opts ...option.OperationOption)

+ func (g *Generator) Head(path string, opts ...option.OperationOption)

+ func (g *Generator) Options(path string, opts ...option.OperationOption)

+ func (g *Generator) Patch(path string, opts ...option.OperationOption)

+ func (g *Generator) Post(path string, opts ...option.OperationOption)

+ func (g *Generator) Put(path string, opts ...option.OperationOption)

+ func (g *Generator) Trace(path string, opts ...option.OperationOption)

+ func (g *Generator) Validate() error

+ type SpecError struct

+ func (se *SpecError) Error() string

+ func (se *SpecError) Errors() []error

+ func (se *SpecError) HasErrors() bool

Jul 30, 2025

Changes in this version

+ const SecuritySchemeAPIKeyInCookie

+ const SecuritySchemeAPIKeyInHeader

+ const SecuritySchemeAPIKeyInQuery

+ type Config struct

+ BaseURL string

+ Description *string

+ DisableOpenAPI bool

+ DocsPath string

+ Logger Logger

+ OpenAPIVersion string

+ SecuritySchemes map[string]*SecurityScheme

+ Servers []Server

+ SwaggerConfig *SwaggerConfig

+ Title string

+ Version string

+ type Generator struct

+ func NewGenerator(configs ...*Config) (*Generator, error)

+ func (g *Generator) AddOperation(ctx OperationContext) error

+ func (g *Generator) GenerateSchema(formats ...string) ([]byte, error)

+ func (g *Generator) NewOperationContext(method, path string) (OperationContext, error)

+ func (g *Generator) WriteSchemaTo(path string) error

+ type Logger interface

+ Printf func(format string, v ...any)

+ type NoopLogger struct

+ func (l NoopLogger) Printf(format string, v ...any)

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlowsDefsAuthorizationCode

+ ClientCredentials *OAuthFlowsDefsClientCredentials

+ Implicit *OAuthFlowsDefsImplicit

+ MapOfAnything map[string]any

+ Password *OAuthFlowsDefsPassword

+ type OAuthFlowsDefsAuthorizationCode struct

+ AuthorizationURL string

+ MapOfAnything map[string]any

+ RefreshURL *string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlowsDefsClientCredentials struct

+ MapOfAnything map[string]any

+ RefreshURL *string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlowsDefsImplicit struct

+ AuthorizationURL string

+ MapOfAnything map[string]any

+ RefreshURL *string

+ Scopes map[string]string

+ type OAuthFlowsDefsPassword struct

+ MapOfAnything map[string]any

+ RefreshURL *string

+ Scopes map[string]string

+ TokenURL string

+ type OperationContext interface

+ OpenAPIOperationContext func() openapi.OperationContext

+ type Reflector interface

+ AddOperation func(oc OperationContext) error

+ NewOperationContext func(method, path string) (OperationContext, error)

+ Spec func() Spec

+ type SecurityScheme struct

+ APIKey *SecuritySchemeAPIKey

+ Description *string

+ HTTPBearer *SecuritySchemeHTTPBearer

+ MapOfAnything map[string]any

+ OAuth2 *SecuritySchemeOAuth2

+ type SecuritySchemeAPIKey struct

+ In SecuritySchemeAPIKeyIn

+ Name string

+ type SecuritySchemeAPIKeyIn string

+ type SecuritySchemeHTTPBearer struct

+ BearerFormat *string

+ Scheme string

+ type SecuritySchemeOAuth2 struct

+ Flows OAuthFlows

+ type Server struct

+ Description *string

+ MapOfAnything map[string]any

+ URL string

+ Variables map[string]ServerVariable

+ type ServerVariable struct

+ Default string

+ Description *string

+ Enum []string

+ MapOfAnything map[string]any

+ type Spec interface

+ MarshalJSON func() ([]byte, error)

+ MarshalYAML func() ([]byte, error)

+ type SwaggerConfig struct

+ HideCurl bool

+ JsonEditor bool

+ PreAuthorizeApiKey map[string]string

+ Proxy bool

+ SettingsUI map[string]string

+ ShowTopBar bool