Versions in this module Expand all Collapse all v4 v4.0.0 Jul 11, 2026 Changes in this version + const Docs + const DocsInfo + const DocsOpenAPI + const DocsVersion + const Health + const HealthDetailed + const Healthz + const Livez + const Metrics + const PprofCmdline + const PprofIndex + const PprofProfile + const PprofSymbol + const PprofTrace + const Readyz + const Version + var AllEndpoints = struct{ ... } + var DocsEndpoints = struct{ ... } + var HealthEndpoints = struct{ ... } + var PprofEndpoints = struct{ ... } + var SystemEndpoints = struct{ ... } + func HTTPProblemResponseName(status int) string + func NullableSchema(schema map[string]any) map[string]any + func ProblemSchema() map[string]any + func RegisterHTTPProblemResponses(registry *Registry, statuses ...int) + func RegisterProblemCatalog(registry *Registry, catalog *httpx.ProblemCatalog) + func RegisterSchemaFrom[T any](registry *Registry, name string, opts SchemaOptions) error + func SchemaFromType(typ reflect.Type, opts SchemaOptions) (map[string]any, error) + func SchemaFrom[T any](opts SchemaOptions) (map[string]any, error) + func SchemaRef(ref string) map[string]any + func SchemaWithEnum(schema map[string]any, values ...any) map[string]any + func SchemaWithExample(schema map[string]any, example any) map[string]any + type Components struct + Responses map[string]Response + Schemas map[string]map[string]any + SecuritySchemes map[string]SecurityScheme + type DocumentationInfo struct + Contact string + Description string + License string + Title string + Version string + type Example struct + Description string + ExternalValue string + Summary string + Value any + type Info struct + Description string + Title string + Version string + type MediaType struct + Example any + Examples map[string]any + Schema map[string]any + SchemaRef string + type OpenAPIVersion string + const OpenAPIVersion30 + const OpenAPIVersion31 + type Operation struct + Deprecated bool + Description string + Extensions map[string]any + Method string + OperationID string + Parameters []Parameter + Path string + RequestBody *RequestBody + Responses map[int]Response + Scopes []string + Security []SecurityRequirement + Summary string + Sunset string + Tags []string + type Parameter struct + Description string + In string + Name string + Required bool + Schema map[string]any + type Registry struct + func NewRegistry(info Info) *Registry + func NewRegistryWithOptions(info Info, opts RegistryOptions) *Registry + func (r *Registry) OpenAPI() ([]byte, error) + func (r *Registry) Operations() []Operation + func (r *Registry) Register(op Operation) + func (r *Registry) RegisterResponse(name string, response Response) + func (r *Registry) RegisterSchema(name string, schema map[string]any) + func (r *Registry) RegisterSecurityScheme(name string, scheme SecurityScheme) + func (r *Registry) SetComponents(components Components) + func (r *Registry) SetSecurity(requirements []SecurityRequirement) + func (r *Registry) SetServers(servers []Server) + type RegistryOptions struct + OpenAPIVersion OpenAPIVersion + type RegistryProvider struct + func NewRegistryProvider(registry *Registry, info DocumentationInfo, openAPIPath string) *RegistryProvider + func (p *RegistryProvider) GetHTML() (string, error) + func (p *RegistryProvider) GetInfo() DocumentationInfo + func (p *RegistryProvider) GetOpenAPI() ([]byte, error) + func (p *RegistryProvider) GetVersion() (string, error) + type RequestBody struct + Content map[string]MediaType + ContentTypes []string + Description string + Required bool + type Response struct + Content map[string]MediaType + ContentTypes []string + Description string + Ref string + func HTTPProblemResponseRef(status int) Response + func ProblemResponse(description string) Response + func ValidationProblemResponse(description string) Response + type SchemaOptions struct + RefPrefix string + type SecurityRequirement struct + Name string + Scopes []string + type SecurityScheme struct + BearerFormat string + Description string + Flows map[string]any + In string + Name string + OpenIDConnectURL string + Scheme string + Type string + type Server struct + Description string + URL string Other modules containing this package github.com/aatuh/api-toolkit github.com/aatuh/api-toolkit/v2 github.com/aatuh/api-toolkit/v3
Go to main page