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
- API
  
  Reference documentation for the pkg.go.dev API
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

Aug 6, 2026

v1.1.0

Aug 6, 2026

v1.0.3

Mar 26, 2025

v1.0.2

Mar 26, 2025

v1.0.1

Mar 26, 2025

v1.0.0

Mar 26, 2025

Changes in this version

+ const OpenAPIVersion

+ func AreSchemasEqual(a, b Schema) bool

+ func GenerateOpenAPISpec(transactions []proxy.APITransaction, ...) ([]byte, error)

+ func GetPathParameters(path, template string) map[string]string

+ type APIDefinition struct

+ BasePath string

+ Components Components

+ Description string

+ Paths map[string]map[string]Operation

+ Title string

+ Version string

+ func NewAPIDefinition(title, description, version, basePath string) *APIDefinition

+ func (d *APIDefinition) AddTransaction(transaction proxy.APITransaction)

+ func (d *APIDefinition) ToOpenAPI() map[string]interface{}

+ type AuthDetector struct

+ func NewAuthDetector() *AuthDetector

+ func (d *AuthDetector) AnalyzeTransaction(req *http.Request, resp *http.Response)

+ func (d *AuthDetector) GetAuthSchemes() []AuthScheme

+ type AuthScheme struct

+ Description string

+ Example string

+ Format string

+ In string

+ Name string

+ Scheme string

+ Type string

+ type Components struct

+ Schemas map[string]Schema

+ type Encoding struct

+ AllowReserved bool

+ ContentType string

+ Explode bool

+ Headers map[string]Header

+ Style string

+ type Example struct

+ Description string

+ ExternalValue string

+ Summary string

+ Value interface{}

+ type Header struct

+ Description string

+ Example interface{}

+ Schema Schema

+ type MediaType struct

+ Encoding map[string]Encoding

+ Example interface{}

+ Examples map[string]Example

+ Schema Schema

+ type Operation struct

+ Deprecated bool

+ Description string

+ OperationID string

+ Parameters []Parameter

+ RequestBody *RequestBody

+ Responses map[string]Response

+ Summary string

+ Tags []string

+ type Parameter struct

+ Description string

+ Example interface{}

+ In string

+ Name string

+ Required bool

+ Schema Schema

+ type PathPatternDetector struct

+ func NewPathPatternDetector() *PathPatternDetector

+ func (d *PathPatternDetector) AddPath(path string)

+ func (d *PathPatternDetector) AnalyzePatterns()

+ func (d *PathPatternDetector) GetPatterns() map[string]string

+ func (d *PathPatternDetector) TemplatizePath(path string) string

+ type RequestBody struct

+ Content map[string]MediaType

+ Description string

+ Required bool

+ func MergeRequestBody(bodies []*RequestBody) *RequestBody

+ type Response struct

+ Content map[string]MediaType

+ Description string

+ Headers map[string]Header

+ func MergeResponse(responses []Response) Response

+ type Schema struct

+ AllOf []Schema

+ AnyOf []Schema

+ Default interface{}

+ Deprecated bool

+ Enum []interface{}

+ Example interface{}

+ ExternalDocs map[string]string

+ Format string

+ Items *Schema

+ Not *Schema

+ Nullable bool

+ OneOf []Schema

+ Properties map[string]Schema

+ ReadOnly bool

+ Required []string

+ Type string

+ WriteOnly bool

+ XML map[string]string

+ func ApplyTypeInference(schema Schema, samples []interface{}, maxSamples int) Schema

+ type SchemaMerger struct

+ func NewSchemaMerger() *SchemaMerger

+ func (m *SchemaMerger) AddSchema(path, method string, schema Schema)

+ func (m *SchemaMerger) MergeSchemas(path, method string) Schema

+ type TypeInferrer struct

+ func NewTypeInferrer(maxSamples int) *TypeInferrer

+ func (t *TypeInferrer) AddSample(path string, value interface{})

+ func (t *TypeInferrer) InferSchema(path string) *Schema

+ func (t *TypeInferrer) ResetSamples()