load

Documentation

Overview

Package load provides a function to load an OpenAPI spec from a URL or a Path

Index

• type Loader
• type OASLoader
  • func NewOASLoader(loader Loader) *OASLoader
  • func (oasLoader *OASLoader) From(path string) (*openapi3.Swagger, error)

Types

type Loader

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

type OASLoader

type OASLoader struct {
	Loader Loader
}

func NewOASLoader

func NewOASLoader(loader Loader) *OASLoader

NewOASLoader returns a loader object that can be used to load OpenAPI specs

func (*OASLoader) From

func (oasLoader *OASLoader) From(path string) (*openapi3.Swagger, error)

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