Help us shape the future of Go! Take the 2026 Go Developer Survey

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
- API
  
  Reference documentation for the pkg.go.dev API
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

openapi

package

Go to main page

Versions in this module

v0

v0.27.0

Sep 25, 2026

v0.26.0

Jun 25, 2026

v0.25.0

Jun 25, 2026

v0.24.0

Jun 24, 2026

v0.23.0

Jun 24, 2026

Changes in this version

+ func NormalizePath(path string) string

+ func PathParams(path string) []string

+ func Register[T any](r *Registry) string

+ func SwaggerHTML(title, specURL string) string

+ type Body struct

+ Description string

+ MediaType string

+ Required bool

+ func BodyOf[T any]() *Body

+ func RawBody(schema *Schema) *Body

+ type OperationConfig struct

+ Description string

+ OperationID string

+ PathParams []Param

+ Query []Param

+ RequestBody *Body

+ Responses map[int]Response

+ Summary string

+ Tags []string

+ type Param struct

+ Description string

+ Name string

+ Required bool

+ Schema *Schema

+ type Registry struct

+ func (r *Registry) Schemas() map[string]*Schema

+ type Response struct

+ Description string

+ MediaType string

+ func JSONResponse[T any](description string) Response

+ func ListResponse[T any](description string) Response

+ func TextResponse(description string) Response

+ type RouteInfo struct

+ Method string

+ Path string

+ PathParams []string

+ func Harvest(app *web.App) []RouteInfo

+ func HarvestRouter(routes []web.Route) []RouteInfo

+ type Schema struct

+ AdditionalProperties *Schema

+ Description string

+ Enum []any

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Format string

+ Items *Schema

+ MaxItems *int

+ MaxLength *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ Minimum *float64

+ Pattern string

+ Properties map[string]*Schema

+ Ref string

+ Required []string

+ Type typeField

+ func SchemaFor(t reflect.Type) *Schema

+ func SchemaOf[T any]() *Schema

+ type Spec struct

+ Description string

+ Title string

+ Version string

+ func FromApp(app *web.App, title, version string) *Spec

+ func New(title, version string) *Spec

+ func (s *Spec) AddServer(url, description string) *Spec

+ func (s *Spec) DocsHandler(specURL string) http.Handler

+ func (s *Spec) Handler() http.Handler

+ func (s *Spec) JSON() ([]byte, error)

+ func (s *Spec) Map() (map[string]any, error)

+ func (s *Spec) Operation(method, path string, cfg OperationConfig) *Spec

+ func (s *Spec) Registry() *Registry

+ func (s *Spec) Tags() []string