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.0.0

Nov 8, 2025

v0

v0.2.1

Aug 27, 2025

Changes in this version

+ const ArrayOfArrayType

+ const ArrayOfObjectType

+ const ArrayOfStringType

+ const ArrayType

+ const BooleanType

+ const ContentTypeFormUrlencoded

+ const ContentTypeJSON

+ const IntegerType

+ const MethodDelete

+ const MethodGet

+ const MethodHead

+ const MethodOptions

+ const MethodPatch

+ const MethodPost

+ const MethodPut

+ const NullType

+ const NumberType

+ const ObjectType

+ const SecurityLocationCookie

+ const SecurityLocationHeader

+ const SecurityLocationQuery

+ const SecurityTypeApiKey

+ const StringType

+ type Documentation struct

+ Options map[string]string

+ type Endpoint struct

+ Deprecated bool

+ Description string

+ Extensions map[string]interface{}

+ Metadata map[string]interface{}

+ Method string

+ OperationID string

+ Parameters []*Parameter

+ Path string

+ Protected bool

+ RequestBody *RequestBody

+ Responses map[string]*Response

+ Schemas []*Schema

+ Security []map[string][]string

+ SecuritySchemas map[string]*SecuritySchema

+ Summary string

+ Tags []string

+ type HTTPDocumentParser interface

+ Parse func(r io.Reader, urlEntity *config.URLEntity, protectedEndpoints []string) ([]Endpoint, error)

+ type HTTPParser struct

+ Client *http.Client

+ DocParser HTTPDocumentParser

+ Name string

+ SamplesDir string

+ UseSamples bool

+ func (p *HTTPParser) Parse(ctx context.Context, doc Documentation) ([]Endpoint, error)

+ type MediaType struct

+ Schema *Schema

+ type Parameter struct

+ Description string

+ In string

+ Name string

+ Required bool

+ Schema *Schema

+ type Parser interface

+ CheckVersion func(ctx context.Context, doc Documentation) (bool, time.Time, error)

+ Parse func(ctx context.Context, doc Documentation) ([]Endpoint, error)

+ type RequestBody struct

+ Content map[string]*MediaType

+ Description string

+ Required bool

+ type Response struct

+ Content map[string]*MediaType

+ Description string

+ Schema string

+ type Schema struct

+ AdditionalProperties *Schema

+ Default interface{}

+ Deprecated bool

+ Description string

+ Enum []interface{}

+ Example interface{}

+ ExclusiveMax bool

+ ExclusiveMin bool

+ Extensions map[string]interface{}

+ Format string

+ Items *Schema

+ Max *float64

+ MaxItems *uint64

+ MaxLength *uint64

+ Min *float64

+ MinItems uint64

+ MinLength uint64

+ MultipleOf *float64

+ Nullable bool

+ OneOf []*Schema

+ Pattern string

+ Properties map[string]*Schema

+ Ref string

+ Required []string

+ Title string

+ Type string

+ UniqueItems bool

+ type SecuritySchema struct

+ In string

+ Name string

+ Type string