Categorygithub.com/NaturalSelectionLabs/goapilibopenapi
package
0.9.3
Repository: https://github.com/naturalselectionlabs/goapi.git
Documentation: pkg.go.dev
Overview
Versions
1
Dependencies
4
Dependents
6
Files
872 SLOC

# Functions

CodeString retrieves an enum value from the enum constants string name.
CodeStrings returns a slice of all String values of the enum.
CodeValues returns all values of the enum.
MethodString retrieves an enum value from the enum constants string name.
MethodStrings returns a slice of all String values of the enum.
MethodValues returns all values of the enum.
ParamInString retrieves an enum value from the enum constants string name.
ParamInStrings returns a slice of all String values of the enum.
ParamInValues returns all values of the enum.
StatusCodeString retrieves an enum value from the enum constants string name.
StatusCodeStrings returns a slice of all String values of the enum.
StatusCodeValues returns all values of the enum.

# Constants

CodeInternalError ...
CodeInvalidParam ...
CodeNotFound ...
ContentTypeBin represents the binary http content type.
ContentTypeJSON represents the JSON http content type.
DELETE ...
GET ...
HEAD ...
HEADER ...
OPTIONS ...
PATCH ...
PATH ...
POST
POST ...
PUT ...
QUERY ...
RFC 9110, 15.3.3.
RFC 5842, 7.1.
RFC 9110, 15.6.3.
RFC 9110, 15.5.1.
RFC 9110, 15.5.10.
RFC 9110, 15.2.1.
RFC 9110, 15.3.2.
RFC 8297.
RFC 9110, 15.5.18.
RFC 4918, 11.4.
RFC 9110, 15.5.4.
RFC 9110, 15.4.3.
RFC 9110, 15.6.5.
RFC 9110, 15.5.11.
RFC 9110, 15.6.6.
RFC 3229, 10.4.1.
RFC 4918, 11.5.
RFC 9110, 15.6.1.
RFC 9110, 15.5.12.
RFC 4918, 11.3.
RFC 5842, 7.2.
RFC 9110, 15.5.6.
RFC 9110, 15.5.20.
RFC 9110, 15.4.2.
RFC 9110, 15.4.1.
RFC 4918, 11.1.
RFC 6585, 6.
RFC 9110, 15.3.5.
RFC 9110, 15.3.4.
RFC 9110, 15.5.7.
RFC 2774, 7.
RFC 9110, 15.5.5.
RFC 9110, 15.6.2.
RFC 9110, 15.4.5.
RFC 9110, 15.3.1.
RFC 9110, 15.3.7.
RFC 9110, 15.5.3.
RFC 9110, 15.4.9.
RFC 9110, 15.5.13.
RFC 6585, 3.
RFC 2518, 10.1.
RFC 9110, 15.5.8.
RFC 9110, 15.5.17.
RFC 9110, 15.5.14.
RFC 6585, 5.
RFC 9110, 15.5.9.
RFC 9110, 15.5.15.
RFC 9110, 15.3.6.
RFC 9110, 15.4.4.
RFC 9110, 15.6.4.
RFC 9110, 15.2.2.
RFC 9110, 15.5.19 (Unused).
RFC 9110, 15.4.8.
RFC 8470, 5.2.
RFC 6585, 4.
RFC 9110, 15.5.2.
RFC 7725, 3.
RFC 9110, 15.5.21.
RFC 9110, 15.5.16.
RFC 9110, 15.5.22.
RFC 9110, 15.4.6.
RFC 2295, 8.1.
TRACE ...

# Structs

CommonError is an error object that contains information about a failed request.
Components represents the components section of an OpenAPI document.
Document represents an OpenAPI document.
Example represents an example in an OpenAPI document.
ExternalDocs represents an externalDocs in an OpenAPI document.
Header represents a header in an OpenAPI document.
Info represents the info section of an OpenAPI document.
OAuthFlowObject represents a OAuthFlowObject in an OpenAPI document.
OAuthFlowsObject represents a OAuthFlowsObject in an OpenAPI document.
Operation represents an operation in an OpenAPI document.
Parameter represents a parameter in an OpenAPI document.
RequestBody represents a request body in an OpenAPI document.
Response represents a response in an OpenAPI document.
ResponseFormatData is the data response format.
ResponseFormatErr is the error response format.
ResponseFormatMeta is the data and meta response format.
Schema represents a schema in an OpenAPI document.
SecurityScheme represents a security scheme in an OpenAPI document.
Server represents a server in an OpenAPI document.
Tag represents a tag in an OpenAPI document.

# Interfaces

ResponseFormat for the json response body.

# Type aliases

Code for common error go:generate go run github.com/ysmood/[email protected] -type=Code -values -transform=snake -trimprefix=Code -json.
Content
Content represents a content in an OpenAPI document.
Extension represents an extension in an OpenAPI document.
Headers represents a headers in an OpenAPI document.
Method for http request go:generate go run github.com/ysmood/[email protected] -type=Method -values.
ParamIn types for openapi request parameter.
Path represents a path in an OpenAPI document.
StatusCode for http response go:generate go run github.com/ysmood/[email protected] -type=StatusCode -values -trimprefix=Status.
Version represents the version of an OpenAPI document.