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

parser

package

Go to main page

Versions in this module

v1

v1.2.0

Nov 11, 2025

v1.1.0

Nov 10, 2025

v1.0.2

Nov 10, 2025

Changes in this version

+ const MaxCachedDocuments

+ const MaxFileSize

+ const MaxRefDepth

+ const ParamInBody

+ const ParamInCookie

+ const ParamInFormData

+ const ParamInHeader

+ const ParamInPath

+ const ParamInQuery

+ const ResponseDefault

+ type Callback map[string]*PathItem

+ type Components struct

+ Callbacks map[string]*Callback

+ Examples map[string]*Example

+ Extra map[string]interface{}

+ Headers map[string]*Header

+ Links map[string]*Link

+ Parameters map[string]*Parameter

+ PathItems map[string]*PathItem

+ RequestBodies map[string]*RequestBody

+ Responses map[string]*Response

+ Schemas map[string]*Schema

+ SecuritySchemes map[string]*SecurityScheme

+ type Contact struct

+ Email string

+ Extra map[string]interface{}

+ Name string

+ URL string

+ type Discriminator struct

+ Extra map[string]interface{}

+ Mapping map[string]string

+ PropertyName string

+ type Encoding struct

+ AllowReserved bool

+ ContentType string

+ Explode *bool

+ Extra map[string]interface{}

+ Headers map[string]*Header

+ Style string

+ type Example struct

+ Description string

+ ExternalValue string

+ Extra map[string]interface{}

+ Ref string

+ Summary string

+ Value interface{}

+ type ExternalDocs struct

+ Description string

+ Extra map[string]interface{}

+ URL string

+ type Header struct

+ CollectionFormat string

+ Content map[string]*MediaType

+ Default interface{}

+ Deprecated bool

+ Description string

+ Enum []interface{}

+ Example interface{}

+ Examples map[string]*Example

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Explode *bool

+ Extra map[string]interface{}

+ Format string

+ Items *Items

+ MaxItems *int

+ MaxLength *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ Minimum *float64

+ MultipleOf *float64

+ Pattern string

+ Ref string

+ Required bool

+ Schema *Schema

+ Style string

+ Type string

+ UniqueItems bool

+ type Info struct

+ Contact *Contact

+ Description string

+ Extra map[string]interface{}

+ License *License

+ Summary string

+ TermsOfService string

+ Title string

+ Version string

+ type Items struct

+ CollectionFormat string

+ Default interface{}

+ Enum []interface{}

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Extra map[string]interface{}

+ Format string

+ Items *Items

+ MaxItems *int

+ MaxLength *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ Minimum *float64

+ MultipleOf *float64

+ Pattern string

+ Type string

+ UniqueItems bool

+ type License struct

+ Extra map[string]interface{}

+ Identifier string

+ Name string

+ URL string

+ type Link struct

+ Description string

+ Extra map[string]interface{}

+ OperationID string

+ OperationRef string

+ Parameters map[string]interface{}

+ Ref string

+ RequestBody interface{}

+ Server *Server

+ type MediaType struct

+ Encoding map[string]*Encoding

+ Example interface{}

+ Examples map[string]*Example

+ Extra map[string]interface{}

+ Schema *Schema

+ type OAS2Document struct

+ BasePath string

+ Consumes []string

+ Definitions map[string]*Schema

+ ExternalDocs *ExternalDocs

+ Extra map[string]interface{}

+ Host string

+ Info *Info

+ OASVersion OASVersion

+ Parameters map[string]*Parameter

+ Paths Paths

+ Produces []string

+ Responses map[string]*Response

+ Schemes []string

+ Security []SecurityRequirement

+ SecurityDefinitions map[string]*SecurityScheme

+ Swagger string

+ Tags []*Tag

+ type OAS3Document struct

+ Components *Components

+ ExternalDocs *ExternalDocs

+ Extra map[string]interface{}

+ Info *Info

+ JSONSchemaDialect string

+ OASVersion OASVersion

+ OpenAPI string

+ Paths Paths

+ Security []SecurityRequirement

+ Servers []*Server

+ Tags []*Tag

+ Webhooks map[string]*PathItem

+ type OASVersion int

+ const OASVersion20

+ const OASVersion300

+ const OASVersion301

+ const OASVersion302

+ const OASVersion303

+ const OASVersion304

+ const OASVersion310

+ const OASVersion311

+ const OASVersion312

+ const OASVersion320

+ const Unknown

+ func ParseVersion(s string) (OASVersion, bool)

+ func (v OASVersion) IsValid() bool

+ func (v OASVersion) String() string

+ type OAuthFlow struct

+ AuthorizationURL string

+ Extra map[string]interface{}

+ RefreshURL string

+ Scopes map[string]string

+ TokenURL string

+ type OAuthFlows struct

+ AuthorizationCode *OAuthFlow

+ ClientCredentials *OAuthFlow

+ Extra map[string]interface{}

+ Implicit *OAuthFlow

+ Password *OAuthFlow

+ type Operation struct

+ Callbacks map[string]*Callback

+ Consumes []string

+ Deprecated bool

+ Description string

+ ExternalDocs *ExternalDocs

+ Extra map[string]interface{}

+ OperationID string

+ Parameters []*Parameter

+ Produces []string

+ RequestBody *RequestBody

+ Responses *Responses

+ Schemes []string

+ Security []SecurityRequirement

+ Servers []*Server

+ Summary string

+ Tags []string

+ type Parameter struct

+ AllowEmptyValue bool

+ AllowReserved bool

+ CollectionFormat string

+ Content map[string]*MediaType

+ Default interface{}

+ Deprecated bool

+ Description string

+ Enum []interface{}

+ Example interface{}

+ Examples map[string]*Example

+ ExclusiveMaximum bool

+ ExclusiveMinimum bool

+ Explode *bool

+ Extra map[string]interface{}

+ Format string

+ In string

+ Items *Items

+ MaxItems *int

+ MaxLength *int

+ Maximum *float64

+ MinItems *int

+ MinLength *int

+ Minimum *float64

+ MultipleOf *float64

+ Name string

+ Pattern string

+ Ref string

+ Required bool

+ Schema *Schema

+ Style string

+ Type string

+ UniqueItems bool

+ type ParseResult struct

+ Data map[string]interface{}

+ Document interface{}

+ Errors []error

+ OASVersion OASVersion

+ Version string

+ Warnings []string

+ type Parser struct

+ ResolveRefs bool

+ ValidateStructure bool

+ func New() *Parser

+ func (p *Parser) Parse(specPath string) (*ParseResult, error)

+ func (p *Parser) ParseBytes(data []byte) (*ParseResult, error)

+ func (p *Parser) ParseReader(r io.Reader) (*ParseResult, error)

+ type PathItem struct

+ Delete *Operation

+ Description string

+ Extra map[string]interface{}

+ Get *Operation

+ Head *Operation

+ Options *Operation

+ Parameters []*Parameter

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ Ref string

+ Servers []*Server

+ Summary string

+ Trace *Operation

+ type Paths map[string]*PathItem

+ type RefResolver struct

+ func NewRefResolver(baseDir string) *RefResolver

+ func (r *RefResolver) Resolve(doc map[string]interface{}, ref string) (interface{}, error)

+ func (r *RefResolver) ResolveAllRefs(doc map[string]interface{}) error

+ func (r *RefResolver) ResolveExternal(ref string) (interface{}, error)

+ func (r *RefResolver) ResolveLocal(doc map[string]interface{}, ref string) (interface{}, error)

+ type Reference struct

+ Description string

+ Extra map[string]interface{}

+ Ref string

+ Summary string

+ type RequestBody struct

+ Content map[string]*MediaType

+ Description string

+ Extra map[string]interface{}

+ Ref string

+ Required bool

+ type Response struct

+ Content map[string]*MediaType

+ Description string

+ Examples map[string]interface{}

+ Extra map[string]interface{}

+ Headers map[string]*Header

+ Links map[string]*Link

+ Ref string

+ Schema *Schema

+ type Responses struct

+ Codes map[string]*Response

+ Default *Response

+ func (r *Responses) UnmarshalYAML(unmarshal func(interface{}) error) error

+ type Schema struct

+ AdditionalItems interface{}

+ AdditionalProperties interface{}

+ AllOf []*Schema

+ Anchor string

+ AnyOf []*Schema

+ CollectionFormat string

+ Comment string

+ Const interface{}

+ Contains *Schema

+ Default interface{}

+ Defs map[string]*Schema

+ DependentRequired map[string][]string

+ DependentSchemas map[string]*Schema

+ Deprecated bool

+ Description string

+ Discriminator *Discriminator

+ DynamicAnchor string

+ DynamicRef string

+ Else *Schema

+ Enum []interface{}

+ Example interface{}

+ Examples []interface{}

+ ExclusiveMaximum interface{}

+ ExclusiveMinimum interface{}

+ ExternalDocs *ExternalDocs

+ Extra map[string]interface{}

+ Format string

+ ID string

+ If *Schema

+ Items interface{}

+ MaxContains *int

+ MaxItems *int

+ MaxLength *int

+ MaxProperties *int

+ Maximum *float64

+ MinContains *int

+ MinItems *int

+ MinLength *int

+ MinProperties *int

+ Minimum *float64

+ MultipleOf *float64

+ Not *Schema

+ Nullable bool

+ OneOf []*Schema

+ Pattern string

+ PatternProperties map[string]*Schema

+ PrefixItems []*Schema

+ Properties map[string]*Schema

+ PropertyNames *Schema

+ ReadOnly bool

+ Ref string

+ Required []string

+ Schema string

+ Then *Schema

+ Title string

+ Type interface{}

+ UniqueItems bool

+ Vocabulary map[string]bool

+ WriteOnly bool

+ XML *XML

+ type SecurityRequirement map[string][]string

+ type SecurityScheme struct

+ AuthorizationURL string

+ BearerFormat string

+ Description string

+ Extra map[string]interface{}

+ Flow string

+ Flows *OAuthFlows

+ In string

+ Name string

+ OpenIDConnectURL string

+ Ref string

+ Scheme string

+ Scopes map[string]string

+ TokenURL string

+ Type string

+ type Server struct

+ Description string

+ Extra map[string]interface{}

+ URL string

+ Variables map[string]ServerVariable

+ type ServerVariable struct

+ Default string

+ Description string

+ Enum []string

+ Extra map[string]interface{}

+ type Tag struct

+ Description string

+ ExternalDocs *ExternalDocs

+ Extra map[string]interface{}

+ Name string

+ type XML struct

+ Attribute bool

+ Extra map[string]interface{}

+ Name string

+ Namespace string

+ Prefix string

+ Wrapped bool

v1.0.1

Nov 10, 2025

v1.0.0

Nov 10, 2025