huma

May 1, 2023

Changes in this version

+ func StoplightElementsHandler(router *Router) http.Handler

type Context

+ Flush func()

Jan 5, 2023

Changes in this version

type Router

+ func GetRouter(ctx context.Context) *Router

+ func (r *Router) GetOperation(id string) *OperationInfo

Sep 21, 2022

Changes in this version

type Operation

+ func (o *Operation) Deprecated()

Sep 12, 2022

Changes in this version

+ func AddAllowedHeaders(name ...string)

+ type APIKeyLocation string

type Operation

+ func (o *Operation) RequestSchemaForContentType(ct string, s *schema.Schema)

type Router

+ func (r *Router) AutoPatch()

+ func (r *Router) DisableAutoPatch()

+ func (r *Router) GatewayAPIKey(name string, description string, keyName string, in APIKeyLocation)

+ func (r *Router) GatewayBearerFormat(name string, description string, format string)

+ func (r *Router) GatewayOpenIDConnect(name string, description string, url string)

+ type SecurityScheme string

+ const SecuritySchemeApiKey

+ const SecuritySchemeHTTP

+ const SecuritySchemeOauth2

+ const SecuritySchemeOpenIdConnect

Jul 27, 2022

Changes in this version

type GraphQLConfig

+ IgnorePrefixes []string

Jun 2, 2022

Changes in this version

+ const DefaultDocsSuffix

+ const DefaultSchemasSuffix

+ const DefaultSpecSuffix

type Router

+ func (r *Router) DocsPath() string

+ func (r *Router) DocsSuffix(suffix string)

+ func (r *Router) SchemasPath() string

+ func (r *Router) SchemasSuffix(suffix string)

+ func (r *Router) SpecSuffix(suffix string)

May 9, 2022

Changes in this version

type Resource

+ func (r *Resource) Hidden()

Apr 7, 2022

Changes in this version

type Context

+ WriteContent func(name string, content io.ReadSeeker, lastModified time.Time)

Mar 21, 2022

Changes in this version

type Router

+ func (r *Router) DisableSchemaProperty()

+ func (r *Router) URLPrefix(value string)

Mar 4, 2022

Changes in this version

+ type GraphQLConfig struct

+ ComplexityLimit int

+ GraphiQL bool

+ Paginator GraphQLPaginator

+ Path string

+ type GraphQLDefaultPaginator struct

+ Edges GraphQLItems

+ Headers GraphQLHeaders

+ Links GraphQLPaginationParams

+ func (g *GraphQLDefaultPaginator) Load(headers map[string]string, body []interface{}) error

+ type GraphQLHeaders map[string]string

+ type GraphQLItems []interface

+ type GraphQLPaginationParams struct

+ First map[string]string

+ Last map[string]string

+ Next map[string]string

+ Prev map[string]string

+ type GraphQLPaginator interface

+ Load func(headers map[string]string, body []interface{}) error

type Router

+ func (r *Router) EnableGraphQL(config *GraphQLConfig)

Feb 17, 2022

Changes in this version

+ func GetConn(ctx context.Context) net.Conn

+ func RapiDocHandler(router *Router) http.Handler

+ func ReDocHandler(router *Router) http.Handler

+ func SwaggerUIHandler(router *Router) http.Handler

+ type AutoConfig struct

+ Headers map[string]string

+ Params map[string]string

+ Prompt map[string]AutoConfigVar

+ Security string

+ type AutoConfigVar struct

+ Default interface{}

+ Description string

+ Enum []interface{}

+ Example string

+ Exclude bool

+ type Context interface

+ AddError func(err error)

+ HasError func() bool

+ SetValue func(key, value interface{})

+ WithValue func(key, value interface{}) Context

+ WriteError func(status int, message string, errors ...error)

+ WriteModel func(status int, model interface{})

+ func ContextFromRequest(w http.ResponseWriter, r *http.Request) Context

+ type ErrorDetail struct

+ Location string

+ Message string

+ Value interface{}

+ func (e *ErrorDetail) Error() string

+ func (e *ErrorDetail) ErrorDetail() *ErrorDetail

+ type ErrorDetailer interface

+ ErrorDetail func() *ErrorDetail

+ type ErrorModel struct

+ Detail string

+ Errors []*ErrorDetail

+ Instance string

+ Status int

+ Title string

+ Type string

+ type Operation struct

+ func (o *Operation) BodyReadTimeout(duration time.Duration)

+ func (o *Operation) MaxBodyBytes(size int64)

+ func (o *Operation) NoBodyReadTimeout()

+ func (o *Operation) NoMaxBody()

+ func (o *Operation) RequestSchema(s *schema.Schema)

+ func (o *Operation) Run(handler interface{})

+ type OperationInfo struct

+ ID string

+ Summary string

+ Tags []string

+ URITemplate string

+ func GetOperationInfo(ctx context.Context) *OperationInfo

+ type Resolver interface

+ Resolve func(ctx Context, r *http.Request)

+ type Resource struct

+ func (r *Resource) Delete(operationID, docs string, responses ...Response) *Operation

+ func (r *Resource) Get(operationID, docs string, responses ...Response) *Operation

+ func (r *Resource) Head(operationID, docs string, responses ...Response) *Operation

+ func (r *Resource) Middleware(middlewares ...func(next http.Handler) http.Handler)

+ func (r *Resource) Operation(method, operationID, docs string, responses ...Response) *Operation

+ func (r *Resource) Patch(operationID, docs string, responses ...Response) *Operation

+ func (r *Resource) Post(operationID, docs string, responses ...Response) *Operation

+ func (r *Resource) Put(operationID, docs string, responses ...Response) *Operation

+ func (r *Resource) SubResource(path string) *Resource

+ func (r *Resource) Tags(names ...string)

+ type Response struct

+ func NewResponse(status int, description string) Response

+ func (r Response) ContentType(ct string) Response

+ func (r Response) GetStatus() int

+ func (r Response) Headers(names ...string) Response

+ func (r Response) Model(bodyModel interface{}) Response

+ type Router struct

+ func New(docs, version string) *Router

+ func (r *Router) AutoConfig(autoConfig AutoConfig)

+ func (r *Router) Contact(name, email, url string)

+ func (r *Router) DefaultBodyReadTimeout(timeout time.Duration)

+ func (r *Router) DefaultServerIdleTimeout(timeout time.Duration)

+ func (r *Router) DocsHandler(handler http.Handler)

+ func (r *Router) DocsPrefix(path string)

+ func (r *Router) GatewayAuthCode(name, authorizeURL, tokenURL string, scopes map[string]string)

+ func (r *Router) GatewayBasicAuth(name string)

+ func (r *Router) GatewayClientCredentials(name, tokenURL string, scopes map[string]string)

+ func (r *Router) GetTitle() string

+ func (r *Router) GetVersion() string

+ func (r *Router) Listen(addr string) error

+ func (r *Router) ListenTLS(addr, certFile, keyFile string) error

+ func (r *Router) Middleware(middlewares ...func(next http.Handler) http.Handler)

+ func (r *Router) OpenAPI() *gabs.Container

+ func (r *Router) OpenAPIHook(hook func(*gabs.Container))

+ func (r *Router) OpenAPIPath() string

+ func (r *Router) Resource(path string) *Resource

+ func (r *Router) SecurityRequirement(name string, scopes ...string)

+ func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ func (r *Router) ServerLink(description, uri string)

+ func (r *Router) Shutdown(ctx context.Context) error