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

goas

module

Go to main page

Versions in this module

v0

v0.1.9

May 22, 2026

Changes in this version

+ type DocumentTags = openapi3.Tags

type SecurityRequirement

+ func NewSecurityRequirement() SecurityRequirement

+ type SecurityRequirements = openapi3.SecurityRequirements

+ type SecurityScheme = openapi3.SecurityScheme

+ type SecuritySchemeRef = openapi3.SecuritySchemeRef

+ type Tag = openapi3.Tag

v0.1.8

May 22, 2026

Changes in this version

+ func Bind(r *http.Request, v interface{}) error

+ func BuildSpec(routes []RouteMeta, cfg Config) *openapi3.T

+ func JSON(w http.ResponseWriter, code int, v interface{})

+ func MultipartSchema(fileField string, fields ...MultipartField) *openapi3.SchemaRef

+ func PathValue(r *http.Request, key string) string

+ func QueryValue[T any](r *http.Request, name string) (T, bool, error)

+ func QueryValues[T any](r *http.Request, name string) ([]T, bool, error)

+ func Register(r *Router, cfg Config)

+ type Config struct

+ DefaultErrorResponses []int

+ DefaultErrorSchema any

+ Description string

+ Schemas SchemaRegistry

+ Security openapi3.SecurityRequirements

+ SecuritySchemes map[string]*openapi3.SecuritySchemeRef

+ SpecPath string

+ SwaggerPath string

+ Tags openapi3.Tags

+ Title string

+ Version string

+ type ErrorResponse struct

+ Error string

+ type Group struct

+ func NewGroup(prefix string, opts []HandlerOption, ...) *Group

+ func (g *Group) DELETE(p string, h http.HandlerFunc, opts ...HandlerOption)

+ func (g *Group) GET(p string, h http.HandlerFunc, opts ...HandlerOption)

+ func (g *Group) Handle(method, p string, h http.HandlerFunc, opts ...HandlerOption)

+ func (g *Group) PATCH(p string, h http.HandlerFunc, opts ...HandlerOption)

+ func (g *Group) POST(p string, h http.HandlerFunc, opts ...HandlerOption)

+ func (g *Group) PUT(p string, h http.HandlerFunc, opts ...HandlerOption)

+ type HandlerOption func(*RouteMeta)

+ func Created(schema ...any) HandlerOption

+ func Headers(params ...HeaderParam) HandlerOption

+ func JSONRoute(reqSchema any, resSchema any, successStatus int) []HandlerOption

+ func MergeOptionSlices(slices ...[]HandlerOption) []HandlerOption

+ func MergeOptions(base []HandlerOption, add ...HandlerOption) []HandlerOption

+ func MultipartUpload(fileField string, fields ...MultipartField) HandlerOption

+ func NoContent() HandlerOption

+ func PathParam(name string, typ ParamType, required bool, description string) HandlerOption

+ func Query(params ...QueryParam) HandlerOption

+ func Req(schema any) HandlerOption

+ func Res(schema any) HandlerOption

+ func Responses(responses ...ResponseSpec) HandlerOption

+ func Security(security *SecurityRequirement) HandlerOption

+ func Status(status int, schema ...any) HandlerOption

+ func Tags(tags ...string) HandlerOption

+ func WithHeaderParams(params ...HeaderParam) HandlerOption

+ func WithPathParam(name string, typ ParamType, required bool, description string) HandlerOption

+ func WithQueryParams(params ...QueryParam) HandlerOption

+ func WithRequestSchema(schema interface{}) HandlerOption

+ func WithResponseSchema(schema interface{}) HandlerOption

+ func WithResponses(responses ...ResponseSpec) HandlerOption

+ func WithSecurity(security *openapi3.SecurityRequirement) HandlerOption

+ func WithTags(tags ...string) HandlerOption

+ type HeaderParam struct

+ Description string

+ Name string

+ Required bool

+ Type ParamType

+ type MultipartField struct

+ Description string

+ Name string

+ Required bool

+ Type ParamType

+ type MultipartFile struct

+ type ParamType string

+ const ParamBoolean

+ const ParamInteger

+ const ParamNumber

+ const ParamString

+ type PathParamSpec struct

+ Description string

+ Name string

+ Required bool

+ Type ParamType

+ type QueryParam struct

+ Description string

+ Name string

+ Required bool

+ Type ParamType

+ type Registry struct

+ type ResponseSpec struct

+ Description string

+ Schema interface{}

+ Status int

+ type RouteMeta struct

+ Description string

+ Handler http.HandlerFunc

+ HeaderParams []HeaderParam

+ Method string

+ Path string

+ PathParams []PathParamSpec

+ QueryParams []QueryParam

+ RequestSchema interface{}

+ ResponseSchema interface{}

+ Responses []ResponseSpec

+ Security *openapi3.SecurityRequirement

+ Summary string

+ Tags []string

+ type Router struct

+ Mux *httpMux

+ func New(cfg ...Config) *Router

+ func NewRouter() *Router

+ func (r *Router) DELETE(path string, h http.HandlerFunc, opts ...HandlerOption)

+ func (r *Router) Docs(cfg ...Config)

+ func (r *Router) GET(path string, h http.HandlerFunc, opts ...HandlerOption)

+ func (r *Router) Get(path string, h http.HandlerFunc)

+ func (r *Router) Group(prefix string, opts ...HandlerOption) *Group

+ func (r *Router) HEAD(path string, h http.HandlerFunc, opts ...HandlerOption)

+ func (r *Router) Handle(method, path string, h http.HandlerFunc, opts ...HandlerOption)

+ func (r *Router) OPTIONS(path string, h http.HandlerFunc, opts ...HandlerOption)

+ func (r *Router) PATCH(path string, h http.HandlerFunc, opts ...HandlerOption)

+ func (r *Router) POST(path string, h http.HandlerFunc, opts ...HandlerOption)

+ func (r *Router) PUT(path string, h http.HandlerFunc, opts ...HandlerOption)

+ func (r *Router) Routes() []RouteMeta

+ func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ type SchemaRegistry map[string]any

+ type SecurityRequirement = openapi3.SecurityRequirement

v0.1.7

May 22, 2026