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

httpx

package

Go to main page

Versions in this module

v2

v2.1.0

May 2, 2026

Changes in this version

+ const TypeNotAcceptable

+ const TypeUnsupportedMedia

+ func WriteProblemCode(w http.ResponseWriter, code ProblemCode)

type Problem

+ func ProblemFromCode(code ProblemCode) (Problem, int)

+ func ProblemFromErrorWithCatalog(err error, catalog *ProblemCatalog, opts ErrorOptions) (Problem, int)

+ type ProblemCatalog struct

+ func DefaultProblemCatalog() *ProblemCatalog

+ func NewProblemCatalog(definitions ...ProblemDefinition) *ProblemCatalog

+ func (c *ProblemCatalog) Definition(code ProblemCode) (ProblemDefinition, bool)

+ func (c *ProblemCatalog) Problem(code ProblemCode, detail string) (Problem, int)

+ func (c *ProblemCatalog) Register(definition ProblemDefinition)

+ type ProblemCode string

+ type ProblemDefinition struct

+ Code ProblemCode

+ Detail string

+ DocumentationURL string

+ LogLevel string

+ Retryable bool

+ Status int

+ Title string

+ Type string

+ type ProblemError struct

+ Code ProblemCode

+ Detail string

+ Err error

+ func NewProblemError(code ProblemCode, detail string, err error) *ProblemError

+ func (e *ProblemError) Error() string

+ func (e *ProblemError) Unwrap() error

v2.0.1

Feb 2, 2026

Changes in this version

+ const DefaultTypeBase

+ const TypeBadRequest

+ const TypeConflict

+ const TypeForbidden

+ const TypeInternal

+ const TypeNotFound

+ const TypePayloadTooLarge

+ const TypeRateLimited

+ const TypeServiceUnavailable

+ const TypeUnauthorized

+ const TypeValidation

+ const ValidationErrorsKey

+ var ErrForbidden = errors.New("forbidden")

+ var ErrHeaderBytesExceeded = errors.New("request headers exceed max bytes")

+ var ErrHeaderCountExceeded = errors.New("request headers exceed max count")

+ var ErrTooManyRequests = errors.New("rate limit exceeded")

+ var ErrUnauthorized = errors.New("unauthorized")

+ var HeaderLimitsBalanced = HeaderLimits

+ var HeaderLimitsRelaxed = HeaderLimits

+ var HeaderLimitsStrict = HeaderLimits

+ func DefaultTypeForStatus(status int) string

+ func DefaultTypeURI(slug string) string

+ func HeaderBytes(h http.Header) int

+ func HeaderCount(h http.Header) int

+ func TypeURI(base, slug string) string

+ func WriteError(w http.ResponseWriter, err error)

+ func WriteErrorStrict(w http.ResponseWriter, err error)

+ func WriteErrorWithOptions(w http.ResponseWriter, err error, opts ErrorOptions)

+ func WriteJSON(w http.ResponseWriter, status int, v any)

+ func WriteProblem(w http.ResponseWriter, status int, p Problem)

+ func WriteProblemWithFieldErrors(w http.ResponseWriter, status int, p Problem, errs fielderrors.FieldErrors)

+ func WriteSimpleProblem(w http.ResponseWriter, status int, title, detail string)

+ type ErrorMode int

+ const ErrorModeDefault

+ const ErrorModeStrict

+ type ErrorOptions struct

+ Mode ErrorMode

+ TypeRegistry *TypeRegistry

+ type HTTPError struct

+ Detail string

+ Err error

+ Status int

+ Title string

+ Type string

+ func NewHTTPError(status int, detail string) *HTTPError

+ func (e *HTTPError) Error() string

+ func (e *HTTPError) Unwrap() error

+ type HeaderLimits struct

+ MaxBytes int

+ MaxCount int

+ func (l HeaderLimits) ApplyServer(s *http.Server)

+ func (l HeaderLimits) Check(r *http.Request) error

+ type Problem struct

+ Detail string

+ Ext map[string]any

+ Instance string

+ Status int

+ Title string

+ Type string

+ func ProblemFromError(err error) (Problem, int)

+ func ProblemFromErrorStrict(err error) (Problem, int)

+ func ProblemFromErrorWithOptions(err error, opts ErrorOptions) (Problem, int)

+ func WithFieldErrors(p Problem, errs fielderrors.FieldErrors) Problem

+ func WithValidationErrors(p Problem, errs fielderrors.FieldErrors) Problem

+ func (p *Problem) With(key string, value any) *Problem

+ type TypeRegistry struct

+ func DefaultTypeRegistry() *TypeRegistry

+ func NewTypeRegistry(base string, slugs ...string) *TypeRegistry

+ func (r *TypeRegistry) Register(slug string) string

+ func (r *TypeRegistry) Types() map[string]string

+ func (r *TypeRegistry) URI(slug string) string

+ type ValidationErrors struct

+ Fields fielderrors.FieldErrors

Other modules containing this package

github.com/aatuh/api-toolkit

github.com/aatuh/api-toolkit/v3

github.com/aatuh/api-toolkit/v4