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

goenax

package module

Go to main page

Versions in this module

v0

v0.3.0

Oct 7, 2026

Changes in this version

type Option

+ func Params[T any]() Option

type Param

+ Schema *Schema

v0.2.0

Oct 7, 2026

Changes in this version

+ const SpecFile

+ func Docs(reg *Registry, info Info, opts ...DocsOption) http.Handler

+ func NormalizePath(path string) string

+ type DocsOption func(*docsConfig)

+ func WithUI(ui UI) DocsOption

type Info

+ ErrorType reflect.Type

type Registry

+ func (r *Registry) Ignore(method, path string)

+ type UI string

+ const Redoc

+ const Scalar

+ const SwaggerUI

v0.1.0

Aug 6, 2026

Changes in this version

+ type Endpoint struct

+ Also []ExtraResponse

+ DependsOn []string

+ Desc string

+ Errors []ErrorSpec

+ Method string

+ Owner string

+ Params []Param

+ Path string

+ Request reflect.Type

+ RespHeaders []ResponseHeader

+ Response reflect.Type

+ Secured bool

+ Status int

+ SuccessHTML bool

+ Summary string

+ Tags []string

+ func Define(method, path string, opts ...Option) Endpoint

+ type ErrorSpec struct

+ Code string

+ Message string

+ Status int

+ type ExtraResponse struct

+ Desc string

+ Status int

+ Type reflect.Type

+ type Info struct

+ Servers []Server

+ Title string

+ Version string

+ type Option func(*Endpoint)

+ func Also(status int, desc string) Option

+ func AlsoJSON[T any](status int, desc string) Option

+ func Compose(opts ...Option) Option

+ func DependsOn(ids ...string) Option

+ func Description(s string) Option

+ func Error(status int, code, message string) Option

+ func HTML() Option

+ func Header(name string, required bool, desc string) Option

+ func NoContent(status int) Option

+ func Owner(s string) Option

+ func PathParam(name, desc string) Option

+ func Query(name string, required bool, desc string) Option

+ func Request[T any]() Option

+ func RespHeader(name, desc string) Option

+ func Response[T any](status int) Option

+ func Secured() Option

+ func Summary(s string) Option

+ func Tags(tags ...string) Option

+ type Param struct

+ Desc string

+ In string

+ Name string

+ Required bool

+ type Registry struct

+ func New() *Registry

+ func (r *Registry) Add(e Endpoint)

+ func (r *Registry) Coverage(actual []Route) (undocumented, unmounted []Route)

+ func (r *Registry) Endpoints() []Endpoint

+ func (r *Registry) Lookup(method, path string) (Endpoint, bool)

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

+ func (r *Registry) Validate() []ValidationError

+ func (r *Registry) ValidateResponse(method, path string, body []byte) error

+ type ResponseHeader struct

+ Desc string

+ Name string

+ type Route struct

+ Method string

+ Path string

+ type Schema struct

+ AdditionalProperties *Schema

+ Enum []string

+ Example any

+ Format string

+ Items *Schema

+ MaxLength *int

+ Maximum *float64

+ MinLength *int

+ Minimum *float64

+ Properties map[string]*Schema

+ Ref string

+ Required []string

+ Type string

+ func SchemaFor(t reflect.Type) Schema

+ type Server struct

+ Description string

+ URL string

+ type ValidationError struct

+ Endpoint string

+ Problems []string

+ func (e ValidationError) Error() string