openapi

package

v1.0.0 Latest Latest Go to latest Published: Apr 14, 2020 License: BSD-3-Clause Imports: 7 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/ExperienceOne/apikit

Links

Open Source Insights

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)

Constants ¶

View Source

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

View Source

const BasicAuthHeaderName string = "Authorization"

Variables ¶

This section is empty.

Functions ¶

This section is empty.

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL