Versions in this module Expand all Collapse all v3 v3.7.0 Jun 16, 2026 Changes in this version + const ServiceOpenApiRegistry + func SpecHandler(info Info, registry *Registry) httpcontract.Handler + func TypeOf[T any]() reflect.Type + type Components struct + Schemas map[string]*Schema + type DescribeOption func(*Descriptor) + func WithDescription(description string) DescribeOption + func WithResponse[T any](status int) DescribeOption + func WithSummary(summary string) DescribeOption + func WithTags(tags ...string) DescribeOption + type Descriptor struct + Description string + RequestType reflect.Type + Responses map[int]reflect.Type + Summary string + Tags []string + type Document struct + Components *Components + ExternalDocs *ExternalDocs + Info Info + OpenApi string + Paths map[string]PathItem + Security []map[string][]string + Servers []Server + Tags []Tag + func Generate(info Info, routeDefinitions []httpcontract.RouteDefinition, registry *Registry) *Document + type ExternalDocs struct + Description string + Url string + type GenerateCommand struct + func NewGenerateCommand(info Info, registry *Registry) *GenerateCommand + func (instance *GenerateCommand) Description() string + func (instance *GenerateCommand) Flags() []clicontract.Flag + func (instance *GenerateCommand) Name() string + func (instance *GenerateCommand) Run(runtimeInstance runtimecontract.Runtime, ...) error + type Info struct + Description string + Title string + Version string + type MediaType struct + Schema *Schema + type Operation struct + Description string + OperationId string + Parameters []Parameter + RequestBody *RequestBody + Responses map[string]ResponseObject + Summary string + Tags []string + type Parameter struct + In string + Name string + Required bool + Schema *Schema + type PathItem struct + Delete *Operation + Get *Operation + Head *Operation + Options *Operation + Patch *Operation + Post *Operation + Put *Operation + Trace *Operation + type Registry struct + func DescribeTyped[Req any, Resp any](registry *Registry, routeName string, status int, options ...DescribeOption) *Registry + func NewRegistry() *Registry + func RegistryMustFromContainer(serviceContainer containercontract.Container) *Registry + func RegistryMustFromResolver(resolver containercontract.Resolver) *Registry + func (instance *Registry) Describe(routeName string, descriptor Descriptor) *Registry + func (instance *Registry) Get(routeName string) (Descriptor, bool) + type RequestBody struct + Content map[string]MediaType + Required bool + type ResponseObject struct + Content map[string]MediaType + Description string + type Schema struct + AdditionalProperties *Schema + AllOf []*Schema + Description string + ExclusiveMaximum *bool + ExclusiveMinimum *bool + Format string + Items *Schema + MaxItems *int + MaxLength *int + Maximum *float64 + MinItems *int + MinLength *int + Minimum *float64 + Nullable bool + Pattern string + Properties map[string]*Schema + Ref string + Required []string + Type string + type Server struct + Description string + Url string + type Tag struct + Description string + Name string
Go to main page