humamux

Documentation

Index

• Variables
• func New(r *mux.Router, config huma.Config, options ...Option) huma.API
• func NewAdapter(r *mux.Router, options ...Option) huma.Adapter
• func NewContext(op *huma.Operation, r *http.Request, w http.ResponseWriter) huma.Context
• func Unwrap(ctx huma.Context) (*http.Request, http.ResponseWriter)
• type Option
  • func WithRouteCustomizer(f func(op *huma.Operation, r *mux.Route)) Option

Variables

var MultipartMaxMemory int64 = 8 * 1024

MultipartMaxMemory is the maximum memory to use when parsing multipart form data.

Functions

func New

func New(r *mux.Router, config huma.Config, options ...Option) huma.API

func NewAdapter

func NewAdapter(r *mux.Router, options ...Option) huma.Adapter

NewAdapter creates a new adapter for the given Gorilla mux.

func NewContext

func NewContext(op *huma.Operation, r *http.Request, w http.ResponseWriter) huma.Context

NewContext creates a new Huma context from an HTTP request and response.

func Unwrap

func Unwrap(ctx huma.Context) (*http.Request, http.ResponseWriter)

Unwrap extracts the underlying HTTP request and response writer from a Huma context. If passed a context from a different adapter it will panic.

Types

type Option

type Option func(*options)

func WithRouteCustomizer

func WithRouteCustomizer(f func(op *huma.Operation, r *mux.Route)) Option

WithRouteCustomizer allows customizing a mux route, like adding HTTP middlewares.