load

Documentation

Overview

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

Index

• func From(loader Loader, path string) (*openapi3.T, error)
• type Loader
• type SpecInfo
  • func FromGlob(loader Loader, glob string) ([]SpecInfo, error)
  • func LoadSpecInfo(loader Loader, location string) (*SpecInfo, error)
  • func LoadSpecInfoFromFile(loader Loader, location string) (*SpecInfo, error)

Functions

func From

func From(loader Loader, path string) (*openapi3.T, 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

Types

type Loader

type Loader interface {
	LoadFromURI(*url.URL) (*openapi3.T, error)
	LoadFromFile(string) (*openapi3.T, error)
}

Loader interface includes the OAS load functions

type SpecInfo

type SpecInfo struct {
	Url  string
	Spec *openapi3.T
}

func FromGlob

func FromGlob(loader Loader, glob string) ([]SpecInfo, error)

FromGlob creates SpecInfo specs from local files matching the specified glob parameter

func LoadSpecInfo

func LoadSpecInfo(loader Loader, location string) (*SpecInfo, error)

LoadSpecInfo creates a SpecInfo from a local file path or a URL

func LoadSpecInfoFromFile

func LoadSpecInfoFromFile(loader Loader, location string) (*SpecInfo, error)

LoadSpecInfoFromFile creates a SpecInfo from a local file path