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 module

Go to main page

Versions in this module

v1

v1.10.0

Jun 25, 2026

Changes in this version

type OpBuilder

+ func (o *OpBuilder) Describe(desc string) *OpBuilder

type SpecConfig

+ OpenAPIVersion string

v1.9.0

Mar 11, 2026

v1.8.1

Dec 15, 2025

Changes in this version

type OpBuilder

+ func (o *OpBuilder) Deprecated() *OpBuilder

type Parameter

+ func DeprecatedQueryParameter(name, description string, typ any) Parameter

v1.8.0

Sep 22, 2025

v1.7.0

Jul 1, 2025

v1.6.0

Feb 4, 2025

v1.5.0

Oct 1, 2024

Changes in this version

+ var SecurityBasic = Security

+ var SecurityBearer = Security

+ var SecurityNone = Security

+ func BuildSpec(r chi.Routes, cfg SpecConfig) (kin.T, error)

+ type OpBuilder struct

+ func Op() *OpBuilder

+ func (o *OpBuilder) Build() func(http.Handler) http.Handler

+ func (o *OpBuilder) BuildHandler() func(http.HandlerFunc) http.HandlerFunc

+ func (o *OpBuilder) Consumes(mediaTypes ...string) *OpBuilder

+ func (o *OpBuilder) Doc(doc string) *OpBuilder

+ func (o *OpBuilder) ID(id string) *OpBuilder

+ func (o *OpBuilder) Param(param Parameter) *OpBuilder

+ func (o *OpBuilder) Params(params ...Parameter) *OpBuilder

+ func (o *OpBuilder) Produces(mediaTypes ...string) *OpBuilder

+ func (o *OpBuilder) Reads(obj any) *OpBuilder

+ func (o *OpBuilder) RequiresAuth(name string, sec Security) *OpBuilder

+ func (o *OpBuilder) Returns(code int, description string, obj any, opts ...ResponseOptFunc) *OpBuilder

+ func (o *OpBuilder) Tag(tag string) *OpBuilder

+ type Operation struct

+ func (o Operation) Merge(newOp Operation) Operation

+ type Parameter struct

+ func HeaderParameter(name, description string) Parameter

+ func ParseParams(obj any, tag string) []Parameter

+ func PathParameter(name, description string) Parameter

+ func QueryParameter(name, description string, typ any) Parameter

+ func QueryParameterWithType(name, description, typ string) Parameter

+ type Response struct

+ type ResponseOptFunc func(*Response)

+ func WithMediaTypes(mediaTypes ...string) ResponseOptFunc

+ func WithResponseHeader(name string) ResponseOptFunc

+ type Security struct

+ APIKeyIn string

+ APIKeyName string

+ BearerFormat string

+ Type string

+ type SpecConfig struct

+ ObjPkgSegments int

+ StripPrefixes []string