Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

swagger

package

Go to main page

Versions in this module

v1

v1.15.0

Jan 19, 2026

v1.14.0

Jan 7, 2026

v1.13.1

Jan 5, 2026

v1.13.0

Jan 5, 2026

v1.12.8

Dec 15, 2025

v1.12.7

Dec 12, 2025

v1.12.6

Dec 12, 2025

v1.12.5

Dec 12, 2025

v1.12.4

Dec 11, 2025

v1.12.3

Dec 11, 2025

v1.12.2

Dec 11, 2025

v1.12.1

Dec 10, 2025

v1.12.0

Dec 10, 2025

v1.11.4

Dec 8, 2025

v1.11.3

Dec 8, 2025

v1.11.2

Dec 8, 2025

v1.11.1

Nov 26, 2025

v1.11.0

Oct 17, 2025

Changes in this version

+ const Version

+ func Marshal(ctx context.Context, swagger *Swagger, w io.Writer) error

+ func Sync(ctx context.Context, model marshaller.Marshallable[core.Swagger]) error

+ func Upgrade(ctx context.Context, src *Swagger) (*openapi.OpenAPI, error)

+ func Walk[T any](ctx context.Context, start *T) iter.Seq[WalkItem]

+ type CollectionFormat string

+ const CollectionFormatCSV

+ const CollectionFormatMulti

+ const CollectionFormatPipes

+ const CollectionFormatSSV

+ const CollectionFormatTSV

+ type Contact struct

+ Email *string

+ Extensions *extensions.Extensions

+ Name *string

+ URL *string

+ func (c *Contact) GetEmail() string

+ func (c *Contact) GetExtensions() *extensions.Extensions

+ func (c *Contact) GetName() string

+ func (c *Contact) GetURL() string

+ func (c *Contact) Validate(ctx context.Context, opts ...validation.Option) []error

+ type ExternalDocumentation struct

+ Description *string

+ Extensions *extensions.Extensions

+ URL string

+ func (e *ExternalDocumentation) GetDescription() string

+ func (e *ExternalDocumentation) GetExtensions() *extensions.Extensions

+ func (e *ExternalDocumentation) GetURL() string

+ func (e *ExternalDocumentation) Validate(ctx context.Context, opts ...validation.Option) []error

+ type HTTPMethod string

+ const HTTPMethodDelete

+ const HTTPMethodGet

+ const HTTPMethodHead

+ const HTTPMethodOptions

+ const HTTPMethodPatch

+ const HTTPMethodPost

+ const HTTPMethodPut

+ type Header struct

+ CollectionFormat *CollectionFormat

+ Default values.Value

+ Description *string

+ Enum []values.Value

+ ExclusiveMaximum *bool

+ ExclusiveMinimum *bool

+ Extensions *extensions.Extensions

+ Format *string

+ Items *Items

+ MaxItems *int64

+ MaxLength *int64

+ Maximum *float64

+ MinItems *int64

+ MinLength *int64

+ Minimum *float64

+ MultipleOf *float64

+ Pattern *string

+ Type string

+ UniqueItems *bool

+ func (h *Header) GetDescription() string

+ func (h *Header) GetExtensions() *extensions.Extensions

+ func (h *Header) GetType() string

+ func (h *Header) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Info struct

+ Contact *Contact

+ Description *string

+ Extensions *extensions.Extensions

+ License *License

+ TermsOfService *string

+ Title string

+ Version string

+ func (i *Info) GetContact() *Contact

+ func (i *Info) GetDescription() string

+ func (i *Info) GetExtensions() *extensions.Extensions

+ func (i *Info) GetLicense() *License

+ func (i *Info) GetTermsOfService() string

+ func (i *Info) GetTitle() string

+ func (i *Info) GetVersion() string

+ func (i *Info) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Items struct

+ CollectionFormat *CollectionFormat

+ Default values.Value

+ Enum []values.Value

+ ExclusiveMaximum *bool

+ ExclusiveMinimum *bool

+ Extensions *extensions.Extensions

+ Format *string

+ Items *Items

+ MaxItems *int64

+ MaxLength *int64

+ Maximum *float64

+ MinItems *int64

+ MinLength *int64

+ Minimum *float64

+ MultipleOf *float64

+ Pattern *string

+ Type string

+ UniqueItems *bool

+ func (i *Items) GetExtensions() *extensions.Extensions

+ func (i *Items) GetType() string

+ func (i *Items) Validate(ctx context.Context, opts ...validation.Option) []error

+ type License struct

+ Extensions *extensions.Extensions

+ Name string

+ URL *string

+ func (l *License) GetExtensions() *extensions.Extensions

+ func (l *License) GetName() string

+ func (l *License) GetURL() string

+ func (l *License) Validate(ctx context.Context, opts ...validation.Option) []error

+ type LocationContext = walkpkg.LocationContext[MatchFunc]

+ type Locations = walkpkg.Locations[MatchFunc]

+ type MatchFunc func(Matcher) error

+ type Matcher struct

+ Any func(any) error

+ Contact func(*Contact) error

+ Discriminator func(*oas3.Discriminator) error

+ Extensions func(*extensions.Extensions) error

+ ExternalDocs func(*ExternalDocumentation) error

+ Header func(*Header) error

+ Info func(*Info) error

+ Items func(*Items) error

+ License func(*License) error

+ Operation func(*Operation) error

+ Parameter func(*Parameter) error

+ PathItem func(*PathItem) error

+ Paths func(*Paths) error

+ ReferencedParameter func(*ReferencedParameter) error

+ ReferencedResponse func(*ReferencedResponse) error

+ Response func(*Response) error

+ Responses func(*Responses) error

+ Schema func(*oas3.JSONSchema[oas3.Concrete]) error

+ SecurityRequirement func(*SecurityRequirement) error

+ SecurityScheme func(*SecurityScheme) error

+ Swagger func(*Swagger) error

+ Tag func(*Tag) error

+ XML func(*oas3.XML) error

+ type OAuth2Flow string

+ const OAuth2FlowAccessCode

+ const OAuth2FlowApplication

+ const OAuth2FlowImplicit

+ const OAuth2FlowPassword

+ type Operation struct

+ Consumes []string

+ Deprecated *bool

+ Description *string

+ Extensions *extensions.Extensions

+ ExternalDocs *ExternalDocumentation

+ OperationID *string

+ Parameters []*ReferencedParameter

+ Produces []string

+ Responses *Responses

+ Schemes []string

+ Security []*SecurityRequirement

+ Summary *string

+ Tags []string

+ func (o *Operation) GetConsumes() []string

+ func (o *Operation) GetDeprecated() bool

+ func (o *Operation) GetDescription() string

+ func (o *Operation) GetExtensions() *extensions.Extensions

+ func (o *Operation) GetExternalDocs() *ExternalDocumentation

+ func (o *Operation) GetOperationID() string

+ func (o *Operation) GetParameters() []*ReferencedParameter

+ func (o *Operation) GetProduces() []string

+ func (o *Operation) GetResponses() *Responses

+ func (o *Operation) GetSchemes() []string

+ func (o *Operation) GetSecurity() []*SecurityRequirement

+ func (o *Operation) GetSummary() string

+ func (o *Operation) GetTags() []string

+ func (o *Operation) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Option func(o *T)

+ func WithSkipValidation() Option[UnmarshalOptions]

+ type Parameter struct

+ AllowEmptyValue *bool

+ CollectionFormat *CollectionFormat

+ Default values.Value

+ Description *string

+ Enum []values.Value

+ ExclusiveMaximum *bool

+ ExclusiveMinimum *bool

+ Extensions *extensions.Extensions

+ Format *string

+ In ParameterIn

+ Items *Items

+ MaxItems *int64

+ MaxLength *int64

+ Maximum *float64

+ MinItems *int64

+ MinLength *int64

+ Minimum *float64

+ MultipleOf *float64

+ Name string

+ Pattern *string

+ Required *bool

+ Schema *oas3.JSONSchema[oas3.Referenceable]

+ Type *string

+ UniqueItems *bool

+ func (p *Parameter) GetDescription() string

+ func (p *Parameter) GetExtensions() *extensions.Extensions

+ func (p *Parameter) GetIn() ParameterIn

+ func (p *Parameter) GetName() string

+ func (p *Parameter) GetRequired() bool

+ func (p *Parameter) GetSchema() *oas3.JSONSchema[oas3.Referenceable]

+ func (p *Parameter) GetType() string

+ func (p *Parameter) Validate(ctx context.Context, opts ...validation.Option) []error

+ type ParameterIn string

+ const ParameterInBody

+ const ParameterInFormData

+ const ParameterInHeader

+ const ParameterInPath

+ const ParameterInQuery

+ type PathItem struct

+ Extensions *extensions.Extensions

+ Parameters []*ReferencedParameter

+ Ref *string

+ func NewPathItem() *PathItem

+ func (p *PathItem) Delete() *Operation

+ func (p *PathItem) Get() *Operation

+ func (p *PathItem) GetExtensions() *extensions.Extensions

+ func (p *PathItem) GetOperation(method HTTPMethod) *Operation

+ func (p *PathItem) GetParameters() []*ReferencedParameter

+ func (p *PathItem) GetRef() string

+ func (p *PathItem) Head() *Operation

+ func (p *PathItem) Options() *Operation

+ func (p *PathItem) Patch() *Operation

+ func (p *PathItem) Post() *Operation

+ func (p *PathItem) Put() *Operation

+ func (p *PathItem) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Paths struct

+ Extensions *extensions.Extensions

+ func NewPaths() *Paths

+ func (p *Paths) GetExtensions() *extensions.Extensions

+ func (p *Paths) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Reference struct

+ Object *T

+ Reference *references.Reference

+ func (r *Reference[T, V, C]) GetObject() *T

+ func (r *Reference[T, V, C]) GetReference() references.Reference

+ func (r *Reference[T, V, C]) IsReference() bool

+ func (r *Reference[T, V, C]) Populate(source any) error

+ func (r *Reference[T, V, C]) Validate(ctx context.Context, opts ...validation.Option) []error

+ type ReferencedParameter = Reference[Parameter, *Parameter, *core.Parameter]

+ func NewReferencedParameterFromParameter(parameter *Parameter) *ReferencedParameter

+ func NewReferencedParameterFromRef(ref references.Reference) *ReferencedParameter

+ type ReferencedResponse = Reference[Response, *Response, *core.Response]

+ func NewReferencedResponseFromRef(ref references.Reference) *ReferencedResponse

+ func NewReferencedResponseFromResponse(response *Response) *ReferencedResponse

+ type Response struct

+ Description string

+ Examples *sequencedmap.Map[string, values.Value]

+ Extensions *extensions.Extensions

+ Headers *sequencedmap.Map[string, *Header]

+ Schema *oas3.JSONSchema[oas3.Referenceable]

+ func (r *Response) GetDescription() string

+ func (r *Response) GetExamples() *sequencedmap.Map[string, values.Value]

+ func (r *Response) GetExtensions() *extensions.Extensions

+ func (r *Response) GetHeaders() *sequencedmap.Map[string, *Header]

+ func (r *Response) GetSchema() *oas3.JSONSchema[oas3.Referenceable]

+ func (r *Response) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Responses struct

+ Default *ReferencedResponse

+ Extensions *extensions.Extensions

+ func NewResponses() *Responses

+ func (r *Responses) GetDefault() *ReferencedResponse

+ func (r *Responses) GetExtensions() *extensions.Extensions

+ func (r *Responses) Validate(ctx context.Context, opts ...validation.Option) []error

+ type SecurityRequirement struct

+ func NewSecurityRequirement() *SecurityRequirement

+ func (s *SecurityRequirement) Validate(ctx context.Context, opts ...validation.Option) []error

+ type SecurityScheme struct

+ AuthorizationURL *string

+ Description *string

+ Extensions *extensions.Extensions

+ Flow *OAuth2Flow

+ In *SecuritySchemeIn

+ Name *string

+ Scopes *sequencedmap.Map[string, string]

+ TokenURL *string

+ Type SecuritySchemeType

+ func (s *SecurityScheme) GetAuthorizationURL() string

+ func (s *SecurityScheme) GetDescription() string

+ func (s *SecurityScheme) GetExtensions() *extensions.Extensions

+ func (s *SecurityScheme) GetFlow() OAuth2Flow

+ func (s *SecurityScheme) GetIn() SecuritySchemeIn

+ func (s *SecurityScheme) GetName() string

+ func (s *SecurityScheme) GetScopes() *sequencedmap.Map[string, string]

+ func (s *SecurityScheme) GetTokenURL() string

+ func (s *SecurityScheme) GetType() SecuritySchemeType

+ func (s *SecurityScheme) Validate(ctx context.Context, opts ...validation.Option) []error

+ type SecuritySchemeIn string

+ const SecuritySchemeInHeader

+ const SecuritySchemeInQuery

+ type SecuritySchemeType string

+ const SecuritySchemeTypeAPIKey

+ const SecuritySchemeTypeBasic

+ const SecuritySchemeTypeOAuth2

+ type Swagger struct

+ BasePath *string

+ Consumes []string

+ Definitions *sequencedmap.Map[string, *oas3.JSONSchema[oas3.Concrete]]

+ Extensions *extensions.Extensions

+ ExternalDocs *ExternalDocumentation

+ Host *string

+ Info Info

+ Parameters *sequencedmap.Map[string, *Parameter]

+ Paths *Paths

+ Produces []string

+ Responses *sequencedmap.Map[string, *Response]

+ Schemes []string

+ Security []*SecurityRequirement

+ SecurityDefinitions *sequencedmap.Map[string, *SecurityScheme]

+ Swagger string

+ Tags []*Tag

+ func Unmarshal(ctx context.Context, doc io.Reader, opts ...Option[UnmarshalOptions]) (*Swagger, []error, error)

+ func (s *Swagger) GetBasePath() string

+ func (s *Swagger) GetConsumes() []string

+ func (s *Swagger) GetDefinitions() *sequencedmap.Map[string, *oas3.JSONSchema[oas3.Concrete]]

+ func (s *Swagger) GetExtensions() *extensions.Extensions

+ func (s *Swagger) GetExternalDocs() *ExternalDocumentation

+ func (s *Swagger) GetHost() string

+ func (s *Swagger) GetInfo() *Info

+ func (s *Swagger) GetParameters() *sequencedmap.Map[string, *Parameter]

+ func (s *Swagger) GetPaths() *Paths

+ func (s *Swagger) GetProduces() []string

+ func (s *Swagger) GetResponses() *sequencedmap.Map[string, *Response]

+ func (s *Swagger) GetSchemes() []string

+ func (s *Swagger) GetSecurity() []*SecurityRequirement

+ func (s *Swagger) GetSecurityDefinitions() *sequencedmap.Map[string, *SecurityScheme]

+ func (s *Swagger) GetSwagger() string

+ func (s *Swagger) GetTags() []*Tag

+ func (s *Swagger) Validate(ctx context.Context, opts ...validation.Option) []error

+ type Tag struct

+ Description *string

+ Extensions *extensions.Extensions

+ ExternalDocs *ExternalDocumentation

+ Name string

+ func (t *Tag) GetDescription() string

+ func (t *Tag) GetExtensions() *extensions.Extensions

+ func (t *Tag) GetExternalDocs() *ExternalDocumentation

+ func (t *Tag) GetName() string

+ func (t *Tag) Validate(ctx context.Context, opts ...validation.Option) []error

+ type UnmarshalOptions struct

+ type WalkItem struct

+ Location Locations

+ Match MatchFunc

+ Swagger *Swagger