load

Documentation

Index

• type Loader
• type SwaggerLoader
  • func NewSwaggerLoader() *SwaggerLoader
  • func (swaggerLoader *SwaggerLoader) From(path string) (*openapi3.Swagger, error)
  • func (swaggerLoader *SwaggerLoader) FromPath(path string) (*openapi3.Swagger, error)
  • func (swaggerLoader *SwaggerLoader) FromURI(path *url.URL) (*openapi3.Swagger, error)

Types

type Loader

type Loader interface {
	LoadSwaggerFromURI(*url.URL) (*openapi3.Swagger, error)
	LoadSwaggerFromFile(string) (*openapi3.Swagger, error)
}

type SwaggerLoader

type SwaggerLoader struct {
	Loader Loader
}

func NewSwaggerLoader

func NewSwaggerLoader() *SwaggerLoader

NewSwaggerLoader returns a loader object that can be used to load swagger specs

func (*SwaggerLoader) From

func (swaggerLoader *SwaggerLoader) From(path string) (*openapi3.Swagger, error)

From is a convenience function that opens a swagger spec from a URL or a local path based on the format of the path parameter

func (*SwaggerLoader) FromPath

func (swaggerLoader *SwaggerLoader) FromPath(path string) (*openapi3.Swagger, error)

FromPath opens a swagger spec from a local path

func (*SwaggerLoader) FromURI

func (swaggerLoader *SwaggerLoader) FromURI(path *url.URL) (*openapi3.Swagger, error)

FromURI opens a swagger spec from a URL