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

api

package

Go to main page

Versions in this module

v1

v1.35.0

Nov 13, 2026

v1.34.0

Nov 12, 2026

v1.33.1

Nov 12, 2026

v1.33.0

Nov 12, 2026

v1.32.0

Nov 11, 2026

v1.31.0

Nov 11, 2026

Changes in this version

+ const DefaultMaxBody

+ func Accept(ctx context.Context) string

+ func DELETE[Req, Res any, P interface{ ... }](g *Group, path, name string, fn func(context.Context, P) (Res, error), ...)

+ func GET[Req, Res any, P interface{ ... }](g *Group, path, name string, fn func(context.Context, P) (Res, error), ...)

+ func Handle[Req, Res any, P interface{ ... }](g *Group, method, path, name string, fn func(context.Context, P) (Res, error), ...)

+ func PATCH[Req, Res any, P interface{ ... }](g *Group, path, name string, fn func(context.Context, P) (Res, error), ...)

+ func POST[Req, Res any, P interface{ ... }](g *Group, path, name string, fn func(context.Context, P) (Res, error), ...)

+ func PUT[Req, Res any, P interface{ ... }](g *Group, path, name string, fn func(context.Context, P) (Res, error), ...)

+ type AuthenticateFunc func(request requests.Request) error

+ type Blob struct

+ Body []byte

+ ContentType string

+ Filename string

+ type Group struct

+ func (g *Group) Group(prefix string, opts ...Option) *Group

+ func (g *Group) Use(m ...echo.MiddlewareFunc)

+ type OperationInfo struct

+ Hidden bool

+ Method string

+ OperationID string

+ Path string

+ Produces []string

+ Public bool

+ SpecPath string

+ Tag string

+ type Option struct

+ func APIKeyHeader(name string) Option

+ func Authenticate(fn AuthenticateFunc) Option

+ func ContentType(mediaType string) Option

+ func Deprecated() Option

+ func Description(description string) Option

+ func Doc(summary string, description ...string) Option

+ func Hidden() Option

+ func Info(title, version string) Option

+ func MaxBodyBytes(n int64) Option

+ func Middleware(m ...echo.MiddlewareFunc) Option

+ func Namer(namer func(reflect.Type) string) Option

+ func Produces[Req any, P interface{ ... }](mediaType string, fn func(context.Context, P) (Blob, error)) Option

+ func Public() Option

+ func Server(url string) Option

+ func Timeout(d time.Duration) Option

+ type Registry struct

+ func New(e *echo.Echo, opts ...Option) *Registry

+ func (r *Registry) Group(prefix string, opts ...Option) *Group

+ func (r *Registry) Operations() []OperationInfo

+ func (r *Registry) Ready()

+ func (r *Registry) Spec(v Version) ([]byte, error)

+ func (r *Registry) StrictSpec() []byte

+ type Version int

+ const V30

+ const V31