package
0.0.0-20211121152213-2400d945f125
Repository: https://github.com/myml/swag.git
Documentation: pkg.go.dev
# Functions
Body defines a body parameter for the swagger endpoint as would commonly be used for the POST, PUT, and PATCH methods prototype should be a struct or a pointer to struct that swag can use to reflect upon the return type.
BodyType defines a body parameter for the swagger endpoint as would commonly be used for the POST, PUT, and PATCH methods prototype should be a struct or a pointer to struct that swag can use to reflect upon the return type t represents the Type of the body.
Consumes sets the endpoint's produces; by default this will be set to application/json.
Description sets the endpoint's description.
Handler allows an instance of the web handler to be associated with the endpoint.
Header adds header definitions to swagger responses.
New constructs a new swagger endpoint using the fields and functional options provided.
NoSecurity explicitly sets the endpoint to have no security requirements.
OperationID sets the endpoint's operationId.
Parameter defines a parameter for the endpoint; see https://swagger.io/docs/specification/2-0/describing-parameters/.
Path defines a path parameter for the endpoint; name, typ, description, and required correspond to the matching swagger fields.
Produces sets the endpoint's produces; by default this will be set to application/json.
Query defines a query parameter for the endpoint; name, typ, description, and required correspond to the matching swagger fields.
QueryEnum defines a query parameter for the endpoint; name, typ, description, required and enum correspond to the matching swagger fields.
RequestHeader defines a header parameter for the endpoint; name, typ, description and required correspond to the matching swagger fields.
Response sets the endpoint response for the specified code; may be used multiple times with different status codes.
ResponseType sets the endpoint response for the specified code; may be used multiple times with different status codes t represents the Type of the response.
Security allows a security scheme to be associated with the endpoint.
Tags allows one or more tags to be associated with the endpoint.
# Type aliases
Option represents a functional option to customize the swagger endpoint.
ResponseOption allows for additional configurations on responses like header information.