api

package

Go to main page

Versions in this module

v0

v0.2.0

Mar 17, 2025

Changes in this version

type IDsInput

+ IDs []ID

v0.1.2

Dec 1, 2024

v0.1.1

Nov 27, 2024

v0.1.0

Nov 26, 2024

v0.0.9

Nov 25, 2024

Changes in this version

type Create

+ Location func(string, M) *CreateResponse

v0.0.8

Nov 23, 2024

v0.0.7

Nov 19, 2024

v0.0.6

Nov 19, 2024

Changes in this version

+ var DefaultAnnotations = []fx.Annotation

v0.0.5

Nov 19, 2024

Changes in this version

+ var MultipartMaxMemory int64 = 8 * 1024

+ func AsHandler(f any) any

+ func AsMiddleware(middleware any) any

+ func AsMiddlewareFunc(name string, ...) any

+ func NewAdapter(r *echo.Echo, g *echo.Group) huma.Adapter

+ type Authorizer func(huma.Context) error

+ type Handler interface

+ Area func() string

+ Register func(*echo.Echo, huma.API)

+ Version func() string

+ type Middleware struct

+ Middleware func(huma.API) func(huma.Context, func(huma.Context))

+ Name string

+ func AuthorizationMiddleware(authorizer Authorizer, logger *zap.Logger) Middleware

+ func NewMiddleware(name string, middleware func(huma.API) func(huma.Context, func(huma.Context))) Middleware

v0.0.4

Nov 11, 2024

v0.0.3

Nov 8, 2024

v0.0.2

Nov 7, 2024

v0.0.1

Nov 5, 2024

Changes in this version

+ func Operation(base ...Option) func(...Option) huma.Operation

+ func Register[I, O any](api huma.API, handler func(context.Context, *I) (*O, error), ...)

+ func Transform[I, O any](errorTransform ErrorTransformerFunc, ...) func(context.Context, *I) (*O, error)

+ func WithCreated(op *huma.Operation)

+ func WithDelete(op *huma.Operation)

+ func WithGet(op *huma.Operation)

+ func WithNoContent(op *huma.Operation)

+ func WithOK(op *huma.Operation)

+ func WithPatch(op *huma.Operation)

+ func WithPost(op *huma.Operation)

+ func WithPut(op *huma.Operation)

+ type CRUD struct

+ Info CRUDInfo

+ func (h CRUD[CB, UB, M, ID]) Area() string

+ func (h CRUD[CB, UB, M, ID]) Register(e *echo.Echo, api huma.API)

+ func (h CRUD[CB, UB, M, ID]) Version() string

+ type CRUDInfo struct

+ Area string

+ Version string

+ type Create struct

+ ErrorTransformer ErrorTransformerFunc

+ Operation huma.Operation

+ Saver func(context.Context, *M) error

+ func NewCreate[B interface{ ... }, M interface{ ... }, ID any](saver func(context.Context, *M) error, errorTransformer ErrorTransformerFunc, ...) Create[B, M, ID]

+ func (h Create[B, M, ID]) Handler(ctx context.Context, in *CreateInput[B]) (*CreateResponse, error)

+ func (h Create[B, M, ID]) Register(_ *echo.Echo, api huma.API)

+ type CreateInput struct

+ Body B

+ type CreateResponse struct

+ Location string

+ func Location[ID any](path string, id ID) *CreateResponse

+ type Delete struct

+ Deleter func(context.Context, ...ID) error

+ ErrorTransformer ErrorTransformerFunc

+ Operation huma.Operation

+ func NewDelete[ID any](deleter func(context.Context, ...ID) error, ...) Delete[ID]

+ func (h Delete[ID]) Handler(ctx context.Context, in *IDInput[ID]) (*struct{}, error)

+ func (h Delete[ID]) Register(_ *echo.Echo, api huma.API)

+ type DeleteMany struct

+ Deleter func(context.Context, ...ID) error

+ ErrorTransformer ErrorTransformerFunc

+ Operation huma.Operation

+ func NewDeleteMany[ID any](deleter func(context.Context, ...ID) error, ...) DeleteMany[ID]

+ func (h DeleteMany[ID]) Handler(ctx context.Context, in *IDsInput[ID]) (*struct{}, error)

+ func (h DeleteMany[ID]) Register(_ *echo.Echo, api huma.API)

+ type ErrorTransformerFunc func(context.Context, error) error

+ type IDInput struct

+ ID ID

+ type IDsInput struct

+ Body struct{ ... }

+ type List struct

+ ErrorTransformer ErrorTransformerFunc

+ Finder func(context.Context, *cr.Criteria) ([]M, int, error)

+ Operation huma.Operation

+ func NewList[T any](finder func(context.Context, *cr.Criteria) ([]T, int, error), ...) List[T]

+ func (h List[M]) Handler(ctx context.Context, in *ListInput) (*Response[ListOutput[M]], error)

+ func (h List[M]) Register(_ *echo.Echo, api huma.API)

+ type ListInput struct

+ Filter string

+ Limit int

+ Page int

+ Sort string

+ func (in *ListInput) Resolve(huma.Context) []error

+ type ListOutput struct

+ Items []E

+ Total int

+ type Option func(*huma.Operation)

+ func WithAddPath(path string) Option

+ func WithAddTags(tags ...string) Option

+ func WithDefaultStatus(status int) Option

+ func WithDescription(description string) Option

+ func WithMetadata(metadata map[string]any) Option

+ func WithMetadataItem(key string, value any) Option

+ func WithMethod(method string) Option

+ func WithOperationID(operationID string) Option

+ func WithPath(path string) Option

+ func WithSecurity(security []map[string][]string) Option

+ func WithSummary(summary string) Option

+ func WithTags(tags ...string) Option

+ type Read struct

+ ErrorTransformer ErrorTransformerFunc

+ Finder func(context.Context, ID) (M, error)

+ Operation huma.Operation

+ func NewRead[T any, ID any](finder func(context.Context, ID) (T, error), ...) Read[T, ID]

+ func (h Read[M, ID]) Handler(ctx context.Context, in *IDInput[ID]) (*Response[M], error)

+ func (h Read[M, ID]) Register(_ *echo.Echo, api huma.API)

+ type Response struct

+ Body B

+ type Update struct

+ ErrorTransformer ErrorTransformerFunc

+ Finder func(context.Context, ID) (M, error)

+ Operation huma.Operation

+ Saver func(context.Context, *M) error

+ func NewUpdate[B interface{ ... }, M any, ID any](finder func(context.Context, ID) (M, error), ...) Update[B, M, ID]

+ func (h Update[B, M, ID]) Handler(ctx context.Context, in *UpdateInput[B, ID]) (*struct{}, error)

+ func (h Update[B, M, ID]) Register(_ *echo.Echo, api huma.API)

+ type UpdateInput struct

+ Body B

+ ID ID

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL