Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

specs

package

Go to main page

Versions in this module

v2

v2.1.0

May 2, 2026

Changes in this version

+ 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)

+ type Components struct

+ Responses map[string]Response

+ Schemas map[string]map[string]any

+ SecuritySchemes map[string]SecurityScheme

+ type MediaType struct

+ Example any

+ Examples map[string]any

+ Schema map[string]any

+ SchemaRef string

type Operation

+ Extensions map[string]any

+ Parameters []Parameter

+ Scopes []string

+ Security []SecurityRequirement

+ Sunset string

+ type Parameter struct

+ Description string

+ In string

+ Name string

+ Required bool

+ Schema map[string]any

type Registry

+ 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)

type RequestBody

+ Content map[string]MediaType

type Response

+ Content map[string]MediaType

+ Ref string

+ 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

v2.0.1

Feb 2, 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{ ... }

+ type Info struct

+ Description string

+ Title string

+ Version string

+ type Operation struct

+ Deprecated bool

+ Description string

+ Method string

+ Path string

+ RequestBody *RequestBody

+ Responses map[int]Response

+ Summary string

+ Tags []string

+ type Registry struct

+ func NewRegistry(info Info) *Registry

+ func (r *Registry) OpenAPI() ([]byte, error)

+ func (r *Registry) Register(op Operation)

+ func (r *Registry) SetServers(servers []Server)

+ type RegistryProvider struct

+ func NewRegistryProvider(registry *Registry, info ports.DocsInfo, openAPIPath string) *RegistryProvider

+ func (p *RegistryProvider) GetHTML() (string, error)

+ func (p *RegistryProvider) GetInfo() ports.DocsInfo

+ func (p *RegistryProvider) GetOpenAPI() ([]byte, error)

+ func (p *RegistryProvider) GetVersion() (string, error)

+ type RequestBody struct

+ ContentTypes []string

+ Description string

+ Required bool

+ type Response struct

+ ContentTypes []string

+ Description string

+ type Server struct

+ Description string

+ URL string

Other modules containing this package

github.com/aatuh/api-toolkit