swagger:default

Usage

// swagger:default

What it does

Marks the surrounding declaration as the spec’s default value for the corresponding shape.

Used in narrow contexts where the scanner expects an explicit anchor for a default. This annotation is value-only — there’s no exported entity it publishes; it’s a classifier hint the scanner consumes during discovery.

Where it goes

On a value declaration (var, const) or a struct field.

Grammar (EBNF)

DefaultClassifierBlock = ANN_DEFAULT , [ Title ] , [ Description ] ;

Takes no argument — an optional title/description may follow on the doc comment.

Supported keywords

None of its own. Most spec defaults are instead carried by the default: keyword on the relevant field; this annotation has a narrow surface and is not commonly authored directly.

Example

swagger:default is value-only: it produces no definition, so there is no emitted spec to render. The source below shows the narrow classifier-hint form — in practice most defaults come from the default: keyword on a field.

// DefaultPort is the fallback port used wherever Port is not supplied. The
// swagger:default annotation is a narrow value-only discovery hint.
//
// swagger:default
var DefaultPort = 8080

Full source: docs/examples/concepts/examples/examples.go