option

var AddError = fuego.OptionAddError

AddError adds an error to the route.

var Cookie = fuego.OptionCookie

Declare a cookie parameter for the route. This will be added to the OpenAPI spec. Example:

Cookie("session_id", "Session ID", param.Required())

The list of options is in the param package.

var Deprecated = fuego.OptionDeprecated

Deprecated marks the route as deprecated.

var Description = fuego.OptionDescription

Description adds a description to the route.

var Group = fuego.GroupOptions

Group allows to group routes under a common path. Useful to group often used middlewares or options and reuse them. Example:

optionsPagination := option.Group(
	option.QueryInt("per_page", "Number of items per page", param.Required()),
	option.QueryInt("page", "Page number", param.Default(1)),
)

var Header = fuego.OptionHeader

Declare a header parameter for the route. This will be added to the OpenAPI spec. Example:

Header("Authorization", "Bearer token", param.Required())

The list of options is in the param package.

var Hide = fuego.OptionHide

Hide hides the route from the OpenAPI spec.

var Middleware = fuego.OptionMiddleware

Middleware adds one or more route-scoped middleware.

var OperationID = fuego.OptionOperationID

OperationID adds an operation ID to the route.

var Param = fuego.OptionParam

Registers a parameter for the route. Prefer using the Query, QueryInt, Header, Cookie shortcuts.

var Query = fuego.OptionQuery

Declare a query parameter for the route. This will be added to the OpenAPI spec. Example:

Query("name", "Filter by name", param.Example("cat name", "felix"), param.Nullable())

The list of options is in the param package.

var QueryBool = fuego.OptionQueryBool

Declare a boolean query parameter for the route. This will be added to the OpenAPI spec. The query parameter is transmitted as a string in the URL, but it is parsed as a boolean. Example:

QueryBool("is_active", "Filter by active status", param.Example("true", true), param.Nullable())

The list of options is in the param package.

var QueryInt = fuego.OptionQueryInt

Declare an integer query parameter for the route. This will be added to the OpenAPI spec. The query parameter is transmitted as a string in the URL, but it is parsed as an integer. Example:

QueryInt("age", "Filter by age (in years)", param.Example("3 years old", 3), param.Nullable())

The list of options is in the param package.

var RequestContentType = fuego.OptionRequestContentType

RequestContentType sets the accepted content types for the route. By default, the accepted content types is */*. This will override any options set at the server level.

var Summary = fuego.OptionSummary

Summary adds a summary to the route.

var Tags = fuego.OptionTags

Tags adds one or more tags to the route.