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

apex

package module

Go to main page

Versions in this module

v0

v0.16.1

Oct 19, 2026

Changes in this version

+ var ErrContextIsClosed = errors.New("cannot perform write actions on a closed context")

+ var ErrInvalidParamLocation = errors.New("parameters can only directly follow a forward slash")

+ var ErrInvalidWildcardLocation = errors.New("wildcards can only directly follow a forward slash")

+ var ErrInvalidWildcardRoute = errors.New("wildcard routes cannot have any additional characters following the asterisk")

+ var ErrMissingLeadSlash = errors.New("invalid route, needs to start with a forward slash")

+ func DecodeJSONValue(r io.Reader, val any) (err error)

+ func UnmarshalJSONValue(bs []byte, val any) (err error)

+ type AdoptResponse struct

+ func NewAdoptResponse() *AdoptResponse

+ func (t *AdoptResponse) ContentType() (contentType string)

+ func (t *AdoptResponse) StatusCode() (code int)

+ func (t *AdoptResponse) WriteTo(w io.Writer) (n int64, err error)

+ type AutoCertConfig struct

+ DirCache string

+ HostPolicy autocert.HostPolicy

+ Hosts []string

+ type Config struct

+ IdleTimeout time.Duration

+ MaxHeaderBytes int

+ ReadTimeout time.Duration

+ WriteTimeout time.Duration

+ type Context struct

+ Params Params

+ func (c *Context) AddHook(fn Hook)

+ func (c *Context) Bind(value any) (err error)

+ func (c *Context) BindForm(value any) (err error)

+ func (c *Context) BindJSON(value any) (err error)

+ func (c *Context) Get(key string) (value string)

+ func (c *Context) Param(key string) (value string)

+ func (c *Context) Put(key, value string)

+ func (c *Context) Redirect(statusCode int, destination string)

+ func (c *Context) Request() *http.Request

+ func (c *Context) WriteBytes(statusCode int, contentType string, bs []byte)

+ func (c *Context) WriteJSON(statusCode int, value any)

+ func (c *Context) WriteNoContent()

+ func (c *Context) WriteReader(statusCode int, contentType string, r io.Reader)

+ func (c *Context) WriteString(statusCode int, contentType, str string)

+ func (c *Context) Writer() http.ResponseWriter

+ type Engine struct

+ func New() *Engine

+ func (e *Engine) Close() error

+ func (e *Engine) DELETE(route string, hs ...Handler) (err error)

+ func (e *Engine) GET(route string, hs ...Handler) (err error)

+ func (e *Engine) Group(route string, hs ...Handler) Group

+ func (e *Engine) Handle(method, route string, hs ...Handler) (err error)

+ func (e *Engine) Listen(port uint16) (err error)

+ func (e *Engine) ListenAutoCertTLS(port uint16, ac AutoCertConfig) (err error)

+ func (e *Engine) ListenAutoCertTLSWithConfig(port uint16, ac AutoCertConfig, c Config) (err error)

+ func (e *Engine) ListenTLS(port uint16, certificateDir string) (err error)

+ func (e *Engine) ListenTLSWithConfig(port uint16, certificateDir string, c Config) (err error)

+ func (e *Engine) ListenWithConfig(port uint16, c Config) (err error)

+ func (e *Engine) OPTIONS(route string, hs ...Handler) (err error)

+ func (e *Engine) POST(route string, hs ...Handler) (err error)

+ func (e *Engine) PUT(route string, hs ...Handler) (err error)

+ func (e *Engine) Set404(h Handler)

+ func (e *Engine) SetOnError(fn func(error))

+ func (e *Engine) SetPanic(h PanicHandler)

+ type Group interface

+ DELETE func(route string, hs ...Handler) error

+ GET func(route string, hs ...Handler) error

+ Group func(route string, hs ...Handler) Group

+ Handle func(method, route string, hs ...Handler) error

+ OPTIONS func(route string, hs ...Handler) error

+ POST func(route string, hs ...Handler) error

+ PUT func(route string, hs ...Handler) error

+ type HTMLResponse struct

+ func NewHTMLResponse(code int, body []byte) *HTMLResponse

+ func (h *HTMLResponse) ContentType() (contentType string)

+ func (h *HTMLResponse) StatusCode() (code int)

+ func (h *HTMLResponse) WriteTo(w io.Writer) (n int64, err error)

+ type Handler func(ctx *Context)

+ type Hook func(statusCode int, ctx *Context)

+ type JSONPResponse struct

+ func NewJSONPResponse(callback string, value any) *JSONPResponse

+ func (j *JSONPResponse) ContentType() (contentType string)

+ func (j *JSONPResponse) StatusCode() (code int)

+ func (j *JSONPResponse) WriteTo(w io.Writer) (n int64, err error)

+ type JSONResponse struct

+ func NewJSONResponse(code int, value any) *JSONResponse

+ func (j *JSONResponse) ContentType() (contentType string)

+ func (j *JSONResponse) StatusCode() (code int)

+ func (j *JSONResponse) WriteTo(w io.Writer) (n int64, err error)

+ type JSONValue struct

+ Data any

+ Errors []error

+ func (j *JSONValue) PushErrors(errs ...error)

+ type NoContentResponse struct

+ func NewNoContentResponse() *NoContentResponse

+ func (t *NoContentResponse) ContentType() (contentType string)

+ func (t *NoContentResponse) StatusCode() (code int)

+ func (t *NoContentResponse) WriteTo(w io.Writer) (n int64, err error)

+ type PanicHandler func(v any)

+ type Param struct

+ Key string

+ Value string

+ type Params []Param

+ func (p Params) ByName(key string) (value string)

+ type RedirectResponse struct

+ func NewRedirectResponse(code int, url string) *RedirectResponse

+ func (r *RedirectResponse) ContentType() (contentType string)

+ func (r *RedirectResponse) StatusCode() (code int)

+ func (r *RedirectResponse) WriteTo(w io.Writer) (n int64, err error)

+ type Response struct

+ Adopted bool

+ Callback string

+ ContentType string

+ StatusCode int

+ Value any

+ func NewAdopedtResponse() *Response

+ func NewResponse(statusCode int, contentType string, value any) *Response

+ type Router struct

+ func (r *Router) DELETE(url string, h Handler) error

+ func (r *Router) GET(url string, h Handler) error

+ func (r *Router) Handle(method, url string, h Handler) (err error)

+ func (r *Router) Match(method, url string) (h Handler, p Params, ok bool)

+ func (r *Router) MatchInto(method, url string, params Params) (h Handler, p Params, ok bool)

+ func (r *Router) OPTIONS(url string, h Handler) error

+ func (r *Router) POST(url string, h Handler) error

+ func (r *Router) PUT(url string, h Handler) error

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

+ func (r *Router) SetNotFound(hs ...Handler)

+ func (r *Router) SetOnError(onError func(error))

+ func (r *Router) SetPanic(h PanicHandler)

+ type Storage map[string]string

+ type TextResponse struct

+ func NewTextResponse(code int, body []byte) *TextResponse

+ func (t *TextResponse) ContentType() (contentType string)

+ func (t *TextResponse) StatusCode() (code int)

+ func (t *TextResponse) WriteTo(w io.Writer) (n int64, err error)

+ type Upgrader struct

+ func NewUpgrader(port uint16, virtualHosts ...VirtualHost) (out *Upgrader, err error)

+ func (u *Upgrader) Close() error

+ func (u *Upgrader) Listen(port uint16) (err error)

+ type VirtualHost struct

+ Domain string

+ Port uint16

+ type XMLResponse struct

+ func NewXMLResponse(code int, value []byte) *XMLResponse

+ func (j *XMLResponse) ContentType() (contentType string)

+ func (j *XMLResponse) StatusCode() (code int)

+ func (j *XMLResponse) WriteTo(w io.Writer) (n int64, err error)

v0.16.0

Oct 19, 2026

v0.1.0

Nov 15, 2019