package
0.19.0
Repository: https://github.com/rws-github/go-swagger.git
Documentation: pkg.go.dev

# Functions

Application scans the application and builds a swagger spec based on the information from the code files.

# Constants

BodyTag used when specifying a response to point to a model/schema.
DescriptionTag used when specifying a response that gives a description of the response.
ParamAllowEmptyKey indicates the tag used to indicate whether a parameter allows empty values in swagger:route.
ParamDescriptionKey indicates the tag used to define a parameter description in swagger:route.
ParamInKey indicates the tag used to define a parameter location in swagger:route.
ParamNameKey indicates the tag used to define a parameter name in swagger:route.
ParamRequiredKey indicates the tag used to declare whether a parameter is required in swagger:route.
ParamTypeKey indicates the tag used to define the parameter type in swagger:route.
ResponseTag used when specifying a response to point to a defined swagger:response.
SchemaDefaultKey indicates the default value for this field in swagger:route.
SchemaEnumKey indicates the tag used to specify the allowed values for this type in swagger:route.
SchemaFormatKey indicates the expected format for this field in swagger:route.
SchemaMaxKey indicates the tag used to indicate the maximum value allowed for this type in swagger:route.
SchemaMaxLenKey indicates the minimum length this field in swagger:route.
SchemaMinKey indicates the tag used to indicate the minimum value allowed for this type in swagger:route.
SchemaMinLenKey indicates the minimum length this field in swagger:route.
TypeArray is the identifier for an array type in swagger:route.
TypeBool is the identifier for a boolean type in swagger:route.
TypeBoolean is the identifier for a boolean type in swagger:route.
TypeInteger is the identifier for an integer type in swagger:route.
TypeNumber is the identifier for a number type in swagger:route.
TypeObject is the identifier for an object type in swagger:route.
TypeString is the identifier for a string type in swagger:route.

# Variables

Debug is true when process is run with DEBUG=1 env var.

# Structs

The Opts for the application scanner.