stdocs

Jun 13, 2026

Changes in this version

type Config

+ DocsSecurityHeaders bool

+ UICSP string

type Option

+ func WithCSP(policy string) Option

+ func WithDocsSecurityHeaders(enabled bool) Option

Jun 12, 2026

Changes in this version

type DefaultResponse

+ RawContentType string

+ type DriftFinding struct

+ Code string

+ Field string

+ Message string

+ Route string

+ Status int

type DriftOption

+ func DriftNotify(fn func(DriftFinding)) DriftOption

type Option

+ func WithDefaultRawResponse(status int, contentType string) Option

type RouteOpt

+ func WithFallbackRawResponse(status int, contentType string) RouteOpt

Jun 12, 2026

Changes in this version

+ type DriftOption func(*driftWarner)

+ func DriftSampleBodies() DriftOption

type RouteOpt

+ func WithFallbackResponse(status int, body any) RouteOpt

+ func WithRawResponse(status int, contentType string) RouteOpt

Jun 12, 2026

Changes in this version

type Config

+ Assets http.Handler

+ TagFunc func(method, path string) string

type Option

+ func WithTagFunc(f func(method, path string) string) Option

type ParamOpt

+ func ParamExclusiveMaximum(n float64) ParamOpt

+ func ParamExclusiveMinimum(n float64) ParamOpt

+ func ParamFormat(format string) ParamOpt

+ func ParamItems(typ string) ParamOpt

+ func ParamMaxItems(n uint64) ParamOpt

+ func ParamMinItems(n uint64) ParamOpt

+ func ParamUniqueItems() ParamOpt

type Warning

+ Code string

Jun 11, 2026

Changes in this version

+ type BodyPart struct

+ func FieldPart(name, typ, description string) BodyPart

+ func FilePart(name, description string) BodyPart

type Config

+ CleanOutput bool

+ ExternalDocs *spec.ExternalDocs

+ OperationIDFunc func(method, path string) string

type Mux

+ func (m *Mux) Lint() []Warning

type Option

+ func WithCleanOutput(enabled bool) Option

+ func WithExternalDocs(url, description string) Option

+ func WithOperationIDFunc(f func(method, path string) string) Option

+ func WithSPDXLicense(name, identifier string) Option

+ func WithTagExternalDocs(tag, url, description string) Option

type RouteOpt

+ func ExternalDocs(url, description string) RouteOpt

+ func WithMultipartBody(parts ...BodyPart) RouteOpt

+ func WithResponseContentType(status int, contentType string) RouteOpt

+ type Warning struct

+ Message string

+ Where string

+ func (w Warning) String() string

Jun 11, 2026

Changes in this version

+ func DriftWarn(m *Mux, logf func(format string, args ...any)) http.Handler

type Config

+ DefaultResponses []DefaultResponse

+ DisableAutoUnauthorized bool

+ PathPrefix string

+ type DefaultResponse struct

+ Body any

+ Status int

type Option

+ func WithAutoUnauthorized(enabled bool) Option

+ func WithDefaultResponse(status int, body any) Option

+ func WithPathPrefix(prefix string) Option

+ type ParamOpt func(p *Param)

+ func ParamDefault(v any) ParamOpt

+ func ParamEnum(values ...any) ParamOpt

+ func ParamExample(v any) ParamOpt

+ func ParamMaxLength(n uint64) ParamOpt

+ func ParamMaximum(n float64) ParamOpt

+ func ParamMinLength(n uint64) ParamOpt

+ func ParamMinimum(n float64) ParamOpt

+ func ParamPattern(pattern string) ParamOpt

+ func ParamRequired() ParamOpt

type RouteOpt

+ func Opts(opts ...RouteOpt) RouteOpt

+ func WithParams(v any) RouteOpt

Jun 10, 2026

Changes in this version

+ func FromDocs(r *http.Request, docsPrefix string) bool

type Mux

+ func (m *Mux) FromDocs(r *http.Request) bool

Jun 10, 2026

Changes in this version

type Config

+ ShowInternal bool

type Option

+ func WithInternal(show bool) Option

type RouteOpt

+ func Hidden() RouteOpt

+ func Internal() RouteOpt

Jun 10, 2026

Changes in this version

+ const OpenAPI30

+ const OpenAPI31

+ const OpenAPI32

+ const SecurityAPIKey

+ const SecurityAPIKeyInCookie

+ const SecurityAPIKeyInHeader

+ const SecurityAPIKeyInQuery

+ const SecurityHTTP

+ const SecurityOAuth2

+ const SecurityOpenIDConnect

+ func DocsHandler(opts ...Option) http.Handler

+ type Config struct

+ DefaultSummary string

+ Disabled bool

+ DocsPrefix string

+ GlobalSecurity []SecurityRequirement

+ Hooks []func(doc map[string]any)

+ Info Info

+ Security []spec.NamedSecurityScheme

+ SelfURL string

+ Servers []Server

+ StaticSpec []byte

+ Tags []TagDecl

+ UIDoc string

+ Version SpecVersion

+ Webhooks map[string]Webhook

+ type Contact = spec.Contact

+ type Info = spec.Info

+ type License = spec.License

+ type Mux struct

+ func New(opts ...Option) *Mux

+ func (m *Mux) Config() *Config

+ func (m *Mux) Docs(enabled ...bool) http.Handler

+ func (m *Mux) Handle(p string, h http.Handler, opts ...RouteOpt)

+ func (m *Mux) HandleFunc(p string, h func(http.ResponseWriter, *http.Request), opts ...RouteOpt)

+ func (m *Mux) JSON() ([]byte, error)

+ func (m *Mux) Mount()

+ func (m *Mux) Refresh()

+ func (m *Mux) YAML() ([]byte, error)

+ type OAuthFlow = spec.OAuthFlow

+ type OAuthFlows = spec.OAuthFlows

+ type Operation = spec.Operation

+ type Option func(*Config)

+ func WithAPIKeyAuth(name, in, paramName string) Option

+ func WithAPIVersion(v string) Option

+ func WithBasicAuth(name string) Option

+ func WithBearerAuth(name, bearerFormat string) Option

+ func WithContact(name, email, url string) Option

+ func WithDefaultSummary(template string) Option

+ func WithDescription(s string) Option

+ func WithDisabled(disabled bool) Option

+ func WithDocsPrefix(prefix string) Option

+ func WithGlobalSecurity(name string, scopes ...string) Option

+ func WithLicense(name, url string) Option

+ func WithOAuth2Auth(name string, flows OAuthFlows) Option

+ func WithOpenAPI(fn func(doc map[string]any)) Option

+ func WithSecurityScheme(name string, scheme SecurityScheme) Option

+ func WithSelfURL(selfURL string) Option

+ func WithServer(url, description string) Option

+ func WithSpec(specJSON []byte) Option

+ func WithTag(name, description string) Option

+ func WithTitle(title string) Option

+ func WithVersion(v SpecVersion) Option

+ func WithWebhooks(hooks map[string]Webhook) Option

+ type Param = spec.Param

+ type PathItem = spec.PathItem

+ type RequestBody = spec.RequestBody

+ type Response = spec.Response

+ type RouteOpt func(*route)

+ func CookieParam(name, typ, desc string) RouteOpt

+ func Deprecated() RouteOpt

+ func Description(s string) RouteOpt

+ func HeaderParam(name, typ, desc string) RouteOpt

+ func OperationID(id string) RouteOpt

+ func Optional() RouteOpt

+ func QueryParam(name, typ, desc string) RouteOpt

+ func Summary(s string) RouteOpt

+ func Tags(names ...string) RouteOpt

+ func WithBody(body any) RouteOpt

+ func WithBodyContentType(ct string) RouteOpt

+ func WithExample(value any) RouteOpt

+ func WithNoSecurity() RouteOpt

+ func WithParam(name, in, typ, description string) RouteOpt

+ func WithResponse(status int, body any) RouteOpt

+ func WithResponseDescription(status int, description string) RouteOpt

+ func WithResponseExample(status int, value any) RouteOpt

+ func WithResponseHeader(status int, name, typ, description string) RouteOpt

+ func WithSecurity(name string, scopes ...string) RouteOpt

+ type SecurityRequirement = spec.SecurityRequirement

+ type SecurityScheme = spec.SecurityScheme

+ type SecuritySchemeType = spec.SecuritySchemeType

+ type Server = spec.Server

+ type SpecInput = spec.SpecInput

+ type SpecVersion = version.SpecVersion

+ type TagDecl = spec.TagDecl

+ type Webhook = spec.Webhook