openapi

Documentation

Index

• Constants
• func GetOperationPath(p string, params openapi3.Parameters) (string, error)
• func NewErrNoSupportedBodyMediaType() error
• func NewErrUnsupportedBearerFormat(bearerFormat string) error
• func NewErrUnsupportedScheme(scheme string) error
• func NewErrUnsupportedSecuritySchemeType(schemeType string) error
• type OpenAPI
  • func LoadFromData(ctx context.Context, data []byte) (*OpenAPI, error)
  • func LoadOpenAPI(ctx context.Context, urlOrPath string) (*OpenAPI, error)
  • func NewOpenAPI(doc *openapi3.T) *OpenAPI
  • func (openapi *OpenAPI) BaseUrl() *url.URL
  • func (openapi *OpenAPI) Operations(client *request.Client, securitySchemes auth.SecuritySchemesMap) (operation.Operations, error)
  • func (openapi *OpenAPI) SecuritySchemeMap(values *SecuritySchemeValues) (auth.SecuritySchemesMap, error)
  • func (openapi *OpenAPI) SetBaseUrl(baseUrl *url.URL) *OpenAPI
  • func (openapi *OpenAPI) Validate(ctx context.Context) error
• type SecuritySchemeValues
  • func NewEmptySecuritySchemeValues() *SecuritySchemeValues
  • func NewSecuritySchemeValues(values map[string]interface{}) *SecuritySchemeValues
  • func (s *SecuritySchemeValues) Get(key string) interface{}
  • func (s *SecuritySchemeValues) GetDefault() interface{}
  • func (s *SecuritySchemeValues) Set(key string, value interface{})
  • func (s *SecuritySchemeValues) WithDefault(defaultValue interface{}) *SecuritySchemeValues

Constants

const (
	FloatParamType   = "float"
	DoubleParamType  = "double"
	Int32ParamFormat = "int32"
	Int64ParamFormat = "int64"
)

const (
	HttpSchemeType          string = "http"
	OAuth2SchemeType        string = "oauth2"
	OpenIdConnectSchemeType string = "openidconnect"
	ApiKeySchemeType        string = "apikey"

	BasicScheme  string = "basic"
	BearerScheme string = "bearer"
)

Functions

func GetOperationPath

func GetOperationPath(p string, params openapi3.Parameters) (string, error)

func NewErrNoSupportedBodyMediaType

func NewErrNoSupportedBodyMediaType() error

func NewErrUnsupportedBearerFormat

func NewErrUnsupportedBearerFormat(bearerFormat string) error

func NewErrUnsupportedScheme

func NewErrUnsupportedScheme(scheme string) error

func NewErrUnsupportedSecuritySchemeType

func NewErrUnsupportedSecuritySchemeType(schemeType string) error

Types

type OpenAPI

type OpenAPI struct {
	Doc *openapi3.T
	// contains filtered or unexported fields
}

func LoadFromData

func LoadFromData(ctx context.Context, data []byte) (*OpenAPI, error)

func LoadOpenAPI

func LoadOpenAPI(ctx context.Context, urlOrPath string) (*OpenAPI, error)

func NewOpenAPI

func NewOpenAPI(doc *openapi3.T) *OpenAPI

func (*OpenAPI) BaseUrl

func (openapi *OpenAPI) BaseUrl() *url.URL

func (*OpenAPI) Operations

func (openapi *OpenAPI) Operations(client *request.Client, securitySchemes auth.SecuritySchemesMap) (operation.Operations, error)

func (*OpenAPI) SecuritySchemeMap

func (openapi *OpenAPI) SecuritySchemeMap(values *SecuritySchemeValues) (auth.SecuritySchemesMap, error)

func (*OpenAPI) SetBaseUrl

func (openapi *OpenAPI) SetBaseUrl(baseUrl *url.URL) *OpenAPI

func (*OpenAPI) Validate

func (openapi *OpenAPI) Validate(ctx context.Context) error

type SecuritySchemeValues

type SecuritySchemeValues struct {
	Default interface{}
	Values  map[string]interface{}
}

func NewEmptySecuritySchemeValues

func NewEmptySecuritySchemeValues() *SecuritySchemeValues

func NewSecuritySchemeValues

func NewSecuritySchemeValues(values map[string]interface{}) *SecuritySchemeValues

func (*SecuritySchemeValues) Get

func (s *SecuritySchemeValues) Get(key string) interface{}

func (*SecuritySchemeValues) GetDefault

func (s *SecuritySchemeValues) GetDefault() interface{}

func (*SecuritySchemeValues) Set

func (s *SecuritySchemeValues) Set(key string, value interface{})

func (*SecuritySchemeValues) WithDefault

func (s *SecuritySchemeValues) WithDefault(defaultValue interface{}) *SecuritySchemeValues