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

openapi

package

Go to main page

Versions in this module

v0

v0.3.0

Aug 27, 2025

Changes in this version

type Schema

+ func (s *Schema) GenerateExample() orderedtypes.Any

v0.2.0

Aug 2, 2025

Changes in this version

type Schema

+ PatternProperties *orderedtypes.Map[string, Schema]

v0.1.1

Aug 1, 2025

v0.1.0

Aug 1, 2025

Changes in this version

+ type Components struct

+ Parameters orderedtypes.Map[string, Parameter]

+ RequestBodies orderedtypes.Map[string, RequestBody]

+ Responses orderedtypes.Map[string, Response]

+ Schemas orderedtypes.Map[string, Schema]

+ SecuritySchemes orderedtypes.Map[string, Security]

+ type Content struct

+ Description string

+ Schema Schema

+ type FullPath struct

+ Method string

+ Operation Operation

+ URL string

+ type Info struct

+ Title string

+ Version string

+ type OpenAPI struct

+ Components Components

+ Info Info

+ Paths orderedtypes.Map[string, Path]

+ Tags []Tag

+ Version string

+ func Parse(filepath string) (*OpenAPI, error)

+ func (o *OpenAPI) GetRef(path string) any

+ func (o OpenAPI) GroupedPaths() []PathGroup

+ type Operation struct

+ Deprecated bool

+ Description string

+ Parameters []Parameter

+ RequestBody *RequestBody

+ Responses orderedtypes.Map[string, *Response]

+ Security []orderedtypes.Map[string, []string]

+ Summary *string

+ Tags []string

+ func (op *Operation) DescriptionAsHTML() string

+ func (op Operation) HasBody() bool

+ func (op Operation) HasParameters() bool

+ func (op Operation) HasResponseInfo() bool

+ func (p Operation) SortedResponses() []ResponseAndStatus

+ type Parameter struct

+ AllowEmptyValue bool

+ Deprecated bool

+ Description string

+ Example any

+ In ParameterLocation

+ Name string

+ Ref string

+ Required bool

+ ResolvedRefName string

+ Schema *Schema

+ type ParameterLocation string

+ const ParameterCookie

+ const ParameterHeader

+ const ParameterPath

+ const ParameterQuery

+ type Path struct

+ Delete *Operation

+ Get *Operation

+ Patch *Operation

+ Post *Operation

+ Put *Operation

+ func (p Path) Methods() iter.Seq2[string, *Operation]

+ type PathGroup struct

+ Paths []FullPath

+ Tag Tag

+ type RequestBody struct

+ Content orderedtypes.Map[string, *Content]

+ Ref string

+ type Response struct

+ Content orderedtypes.Map[string, Content]

+ Description string

+ Ref string

+ ResolvedRefName string

+ type ResponseAndStatus struct

+ Status string

+ type Schema struct

+ AdditionalProperties *Schema

+ AnyOf []Schema

+ Description string

+ Enum []any

+ Example any

+ Examples []orderedtypes.Any

+ Items *Schema

+ Properties *orderedtypes.Map[string, Schema]

+ Ref string

+ Required []string

+ ResolvedRefName string

+ Type any

+ func (s *Schema) DescriptionAsHTML() string

+ func (s Schema) JSON() string

+ func (s Schema) TypeName() string

+ type Security struct

+ BearerFormat string

+ Description string

+ Flows SecurityFlows

+ In string

+ Name string

+ OpenIdConnectURL string

+ Scheme string

+ Type SecurityType

+ func (s *Security) DescriptionAsHTML() string

+ type SecurityFlow struct

+ AuthorizationURL string

+ RefreshURL string

+ Scopes *orderedtypes.Map[string, string]

+ TokenURL string

+ type SecurityFlows struct

+ AuthorizationCode *SecurityFlow

+ ClientCredentials *SecurityFlow

+ Implicit *SecurityFlow

+ Password *SecurityFlow

+ func (sf *SecurityFlows) Iter() iter.Seq2[string, *SecurityFlow]

+ type SecurityType string

+ const SecurityApiKey

+ const SecurityHttp

+ const SecurityMutualTLS

+ const SecurityOAuth2

+ const SecurityOpenIdConnect

+ type Tag struct

+ Name string