humagin

Documentation

Index

• Variables
• func New(r *gin.Engine, config huma.Config) huma.API
• func NewWithGroup(r *gin.Engine, g *gin.RouterGroup, config huma.Config) huma.API
• func Unwrap(ctx huma.Context) *gin.Context
• type Router

Variables

var MultipartMaxMemory int64 = 8 * 1024

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

Functions

func New

func New(r *gin.Engine, config huma.Config) huma.API

func NewWithGroup

func NewWithGroup(r *gin.Engine, g *gin.RouterGroup, config huma.Config) huma.API

NewWithGroup creates a new Huma API using the provided Gin router and group, letting you mount the API at a sub-path. Can be used in combination with the `OpenAPI.Servers` field to set the correct base URL for the API / docs / schemas / etc.

func Unwrap

func Unwrap(ctx huma.Context) *gin.Context

Unwrap extracts the underlying Gin context from a Huma context. If passed a context from a different adapter it will panic.

Types

type Router

type Router interface {
	Handle(string, string, ...gin.HandlerFunc) gin.IRoutes
}

Router is an interface that wraps the Gin router's Handle method.