openapi

Documentation

Index

• Constants
• type ParameterType
  • func (p ParameterType) String() string
• type SecurityType
  • func (s SecurityType) String() string
• type Spec
  • func NewOpenApiSpecFromFile(path string) (*Spec, error)
  • func (oas *Spec) Definitions() spec.Definitions
  • func (oas *Spec) GlobalConsumes() []string
  • func (oas *Spec) GlobalProduces() []string
  • func (oas *Spec) GlobalSecurities() []map[string][]string
  • func (oas *Spec) Info() *spec.InfoProps
  • func (oas *Spec) MarshalJSON() ([]byte, error)
  • func (oas *Spec) Parameters() map[string]spec.Parameter
  • func (oas *Spec) Paths() map[string]spec.PathItem
  • func (oas *Spec) SecurityScheme(name string) *spec.SecurityScheme
  • func (oas *Spec) Validate() error

Constants

const (
	UUID  = "uuid"
	URL   = "url"
	EMAIL = "email"
)

const BasicAuthHeaderName string = "Authorization"

Types

type ParameterType

type ParameterType string

const (
	Query    ParameterType = "query"
	Path     ParameterType = "path"
	Header   ParameterType = "header"
	Body     ParameterType = "body"
	FormData ParameterType = "formData"
)

func (ParameterType) String

func (p ParameterType) String() string

type SecurityType

type SecurityType string

const (
	Basic  SecurityType = "basic"
	ApiKey SecurityType = "apiKey"
)

func (SecurityType) String

func (s SecurityType) String() string

type Spec

type Spec struct {
	Spec *spec.Swagger
	// contains filtered or unexported fields
}

func NewOpenApiSpecFromFile

func NewOpenApiSpecFromFile(path string) (*Spec, error)

func (*Spec) Definitions

func (oas *Spec) Definitions() spec.Definitions

func (*Spec) GlobalConsumes

func (oas *Spec) GlobalConsumes() []string

A list of MIME types the APIs on this resource can consume. This is global to all APIs but can be overridden on specific API calls.

func (*Spec) GlobalProduces

func (oas *Spec) GlobalProduces() []string

	A list of MIME types the APIs on this resource can produce.
 This is global to all APIs but can be overridden on specific API calls.

func (*Spec) GlobalSecurities

func (oas *Spec) GlobalSecurities() []map[string][]string

func (*Spec) Info

func (oas *Spec) Info() *spec.InfoProps

func (*Spec) MarshalJSON

func (oas *Spec) MarshalJSON() ([]byte, error)

func (*Spec) Parameters

func (oas *Spec) Parameters() map[string]spec.Parameter

func (*Spec) Paths

func (oas *Spec) Paths() map[string]spec.PathItem

func (*Spec) SecurityScheme

func (oas *Spec) SecurityScheme(name string) *spec.SecurityScheme

func (*Spec) Validate

func (oas *Spec) Validate() error