modulepackage
0.0.0-20220222184645-f755f484ff34
Repository: https://github.com/istreamlabs/huma.git
Documentation: pkg.go.dev
# README
This fork has been shut down, please use https://huma.rocks/ instead!
Files have been left intact so existing imports continue to work, however no new commits will be made to this repository. You have been warned!
# Packages
No description provided by the author
No description provided by the author
No description provided by the author
Package humatest provides testing utilities for testing Huma-powered services.
No description provided by the author
No description provided by the author
No description provided by the author
Package schema implements OpenAPI 3 compatible JSON Schema which can be generated from structs.
# Functions
ContextFromRequest returns a Huma context for a request, useful for accessing high-level convenience functions from e.g.
GetConn gets the underlying `net.Conn` from a context.
GetOperationInfo returns information about the current Huma operation.
New creates a new Huma router to which you can attach resources, operations, middleware, etc.
NewResponse creates a new response representation.
RapiDocHandler renders documentation using RapiDoc.
ReDocHandler renders documentation using ReDoc.
SwaggerUIHandler renders documentation using Swagger UI.
# Structs
AutoConfig holds an API's automatic configuration settings for the CLI.
AutoConfigVar represents a variable given by the user when prompted during auto-configuration setup of an API.
ErrorDetail provides details about a specific error.
ErrorModel defines a basic error message model.
Operation represents an operation (an HTTP verb, e.g.
OperationInfo describes an operation.
Resource represents an API resource attached to a router at a specific path (URI template).
Response describes an HTTP response that can be returned from an operation.
Router is the entrypoint to your API.
# Interfaces
Context provides a request context and response writer with convenience functions for error and model marshaling in handler functions.
ErrorDetailer returns error details for responses & debugging.
Resolver provides a way to resolve input values from a request or to post- process input values in some way, including additional validation beyond what is possible with JSON Schema alone.