openapi

Documentation

Overview

Package openapi represents OpenAPI v3 Specification in Go.

Index

• type API
• type Components
• type Encoding
• type Example
• type Header
• type MediaType
• type OAuthFlow
• type OAuthFlows
• type Operation
• type Parameter
• type ParameterContent
• type ParameterLocation
  • func (l ParameterLocation) Cookie() bool
  • func (l ParameterLocation) Header() bool
  • func (l ParameterLocation) Path() bool
  • func (l ParameterLocation) Query() bool
• type ParameterStyle
  • func (s ParameterStyle) String() string
• type Path
  • func (p Path) ID() (path string)
  • func (p Path) String() (path string)
• type PathPart
  • func (p PathPart[P]) IsParam() bool
• type Ref
• type RequestBody
• type Response
• type Responses
  • func (r *Responses) Add(pattern string, resp *Response) error
• type Security
• type SecurityRequirement
• type SecurityRequirements
• type SecurityScheme
• type Server
• type ServerURL
• type ServerVariable
• type Version
  • func (v *Version) MarshalText() ([]byte, error)
  • func (v Version) String() string
  • func (v *Version) UnmarshalText(text []byte) error
• type Webhook

Types

type API

type API struct {
	Servers    []Server
	Operations []*Operation
	Webhooks   []Webhook
	Components *Components
}

API represents parsed OpenAPI spec.

type Components

type Components struct {
	Schemas       map[string]*jsonschema.Schema
	Responses     map[string]*Response
	Parameters    map[string]*Parameter
	Examples      map[string]*Example
	RequestBodies map[string]*RequestBody
}

Components represent parsed components of OpenAPI spec.

type Encoding

type Encoding struct {
	ContentType   string
	Headers       map[string]*Header
	Style         ParameterStyle
	Explode       bool
	AllowReserved bool

	location.Pointer `json:"-" yaml:"-"`
}

Encoding is Encoding Type Object.

type Example

type Example struct {
	Ref Ref

	Summary       string
	Description   string
	Value         jsonschema.Example
	ExternalValue string

	location.Pointer `json:"-" yaml:"-"`
}

Example is an OpenAPI Example.

type Header

type Header = Parameter

Header is an OpenAPI Header definition.

type MediaType

type MediaType struct {
	Schema   *jsonschema.Schema
	Example  json.RawMessage
	Examples map[string]*Example
	Encoding map[string]*Encoding

	XOgenJSONStreaming bool

	location.Pointer `json:"-" yaml:"-"`
}

MediaType is Media Type Object.

type OAuthFlow

type OAuthFlow struct {
	AuthorizationURL string
	TokenURL         string
	RefreshURL       string
	Scopes           map[string]string // name -> description

	location.Pointer `json:"-" yaml:"-"`
}

OAuthFlow is configuration details for a supported OAuth Flow.

type OAuthFlows

type OAuthFlows struct {
	Implicit          *OAuthFlow
	Password          *OAuthFlow
	ClientCredentials *OAuthFlow
	AuthorizationCode *OAuthFlow

	location.Pointer `json:"-" yaml:"-"`
}

OAuthFlows allows configuration of the supported OAuth Flows.

type Operation

type Operation struct {
	OperationID string // optional
	Summary     string // optional
	Description string // optional
	Deprecated  bool   // optional

	HTTPMethod  string
	Path        Path
	Parameters  []*Parameter
	RequestBody *RequestBody // optional

	// Security requirements.
	Security SecurityRequirements

	// Operation responses.
	Responses Responses

	location.Pointer `json:"-" yaml:"-"`
}

Operation is an OpenAPI Operation.

type Parameter

type Parameter struct {
	Ref Ref

	Name          string
	Description   string
	Deprecated    bool
	Schema        *jsonschema.Schema
	Content       *ParameterContent
	In            ParameterLocation
	Style         ParameterStyle
	Explode       bool
	Required      bool
	AllowReserved bool

	location.Pointer `json:"-" yaml:"-"`
}

Parameter is an OpenAPI Operation Parameter.

type ParameterContent

type ParameterContent struct {
	Name  string
	Media *MediaType
}

ParameterContent describes OpenAPI Parameter content field.

Parameter "content" field described as a map, and it MUST only contain one entry.

type ParameterLocation

type ParameterLocation string

ParameterLocation defines where OpenAPI parameter is located.

const (
	// LocationQuery is "query" parameter location.
	LocationQuery ParameterLocation = "query"
	// LocationHeader is "header" parameter location.
	LocationHeader ParameterLocation = "header"
	// LocationPath is "path" parameter location.
	LocationPath ParameterLocation = "path"
	// LocationCookie is "cookie" parameter location.
	LocationCookie ParameterLocation = "cookie"
)

func (ParameterLocation) Cookie

func (l ParameterLocation) Cookie() bool

Cookie whether parameter location is cookie.

func (ParameterLocation) Header

func (l ParameterLocation) Header() bool

Header whether parameter location is header.

func (ParameterLocation) Path

func (l ParameterLocation) Path() bool

Path whether parameter location is path.

func (ParameterLocation) Query

func (l ParameterLocation) Query() bool

Query whether parameter location is query.

type ParameterStyle

type ParameterStyle string

ParameterStyle is an OpenAPI Parameter style.

const (
	PathStyleSimple ParameterStyle = "simple"
	PathStyleLabel  ParameterStyle = "label"
	PathStyleMatrix ParameterStyle = "matrix"

	QueryStyleForm           ParameterStyle = "form"
	QueryStyleSpaceDelimited ParameterStyle = "spaceDelimited"
	QueryStylePipeDelimited  ParameterStyle = "pipeDelimited"
	QueryStyleDeepObject     ParameterStyle = "deepObject"

	HeaderStyleSimple ParameterStyle = "simple"

	CookieStyleForm ParameterStyle = "form"
)

https://swagger.io/docs/specification/serialization/

func (ParameterStyle) String

func (s ParameterStyle) String() string

String implements fmt.Stringer.

type Path

type Path []PathPart[*Parameter]

Path is an operation path.

func (Path) ID

func (p Path) ID() (path string)

ID returns path, but without parameter names.

For example, if path is "/users/{id}", ID returns "/users/{}".

func (Path) String

func (p Path) String() (path string)

String implements fmt.Stringer.

type PathPart

type PathPart[P any] struct {
	Raw   string
	Param P
}

PathPart is a part of an OpenAPI Operation Path.

func (PathPart[P]) IsParam

func (p PathPart[P]) IsParam() bool

IsParam returns true if part is a parameter.

type Ref

type Ref = jsonpointer.RefKey

Ref is a JSON Reference.

type RequestBody

type RequestBody struct {
	Ref         Ref
	Description string
	Required    bool
	Content     map[string]*MediaType

	location.Pointer `json:"-" yaml:"-"`
}

RequestBody of an OpenAPI Operation.

type Response

type Response struct {
	Ref         Ref
	Description string
	Headers     map[string]*Header
	Content     map[string]*MediaType

	location.Pointer `json:"-" yaml:"-"`
}

Response is an OpenAPI Response definition.

type Responses

type Responses struct {
	StatusCode map[int]*Response
	Pattern    [5]*Response
	Default    *Response

	location.Pointer `json:"-" yaml:"-"`
}

Responses contains a list of parsed OpenAPI Responses.

func (*Responses) Add

func (r *Responses) Add(pattern string, resp *Response) error

Add adds a response to the Responses.

type Security

type Security struct {
	Type             string
	Description      string
	Name             string
	In               string
	Scheme           string
	BearerFormat     string
	Flows            OAuthFlows
	OpenIDConnectURL string

	location.Pointer `json:"-" yaml:"-"`
}

Security is parsed security scheme.

type SecurityRequirement

type SecurityRequirement struct {
	// Each element needs to be satisfied to authorize the request.
	Schemes []SecurityScheme

	location.Pointer `json:"-" yaml:"-"`
}

SecurityRequirement is parsed security requirement.

type SecurityRequirements

type SecurityRequirements []SecurityRequirement

SecurityRequirements are parsed security requirements.

Only one element needs to be satisfied to authorize the request.

type SecurityScheme

type SecurityScheme struct {
	Name     string
	Scopes   []string
	Security Security
}

SecurityScheme defines one of security schemes used in the security requirement.

type Server

type Server struct {
	Name        string // optional,extension
	Description string // optional
	Template    ServerURL
}

Server represents parsed OpenAPI Server Object.

type ServerURL

type ServerURL []PathPart[ServerVariable]

ServerURL is URL template with variables.

type ServerVariable

type ServerVariable struct {
	Name    string
	Default string
	Enum    []string
}

ServerVariable represents parsed OpenAPI Server Variable Object.

type Version

type Version struct {
	// Major is the major version number.
	Major int
	// Minor is the minor version number.
	Minor int
	// Patch is the patch version number.
	Patch int
}

Version represents OpenAPI version.

func (*Version) MarshalText

func (v *Version) MarshalText() ([]byte, error)

MarshalText implements encoding.TextMarshaler.

func (Version) String

func (v Version) String() string

String returns the string representation of the version.

func (*Version) UnmarshalText

func (v *Version) UnmarshalText(text []byte) error

UnmarshalText implements encoding.TextUnmarshaler.

type Webhook

type Webhook struct {
	// Name of the webhook.
	Name string
	// Operations of the webhook's Path Item.
	Operations []*Operation

	location.Pointer `json:"-" yaml:"-"`
}

Webhook is an OpenAPI Webhook.