package loads

import "github.com/go-openapi/loads"

Package loads provides document loading methods for swagger (OAI) specifications.

It is used by other go-openapi packages to load and run analysis on local or remote spec documents.

Index ¶

• func AddLoader(predicate DocMatcher, load DocLoader)
• func JSONDoc(path string) (json.RawMessage, error)
• type DocLoader
• type DocMatcher
• type Document
• func Analyzed(data json.RawMessage, version string) (*Document, error)
• func Embedded(orig, flat json.RawMessage) (*Document, error)
• func JSONSpec(path string) (*Document, error)
• func Spec(path string) (*Document, error)
• func (d *Document) BasePath() string
• func (d *Document) Expanded(options ...*spec.ExpandOptions) (*Document, error)
• func (d *Document) Host() string
• func (d *Document) OrigSpec() *spec.Swagger
• func (d *Document) Pristine() *Document
• func (d *Document) Raw() json.RawMessage
• func (d *Document) ResetDefinitions() *Document
• func (d *Document) Schema() *spec.Schema
• func (d *Document) Spec() *spec.Swagger
• func (d *Document) SpecFilePath() string
• func (d *Document) Version() string

Functions ¶

func AddLoader ¶

func AddLoader(predicate DocMatcher, load DocLoader)

AddLoader for a document

func JSONDoc ¶

func JSONDoc(path string) (json.RawMessage, error)

JSONDoc loads a json document from either a file or a remote url

Types ¶

type DocLoader ¶

type DocLoader func(string) (json.RawMessage, error)

DocLoader represents a doc loader type

type DocMatcher ¶

type DocMatcher func(string) bool

DocMatcher represents a predicate to check if a loader matches

type Document ¶

type Document struct {
	// specAnalyzer
	Analyzer *analysis.Spec
	// contains filtered or unexported fields
}

Document represents a swagger spec document

func Analyzed ¶

func Analyzed(data json.RawMessage, version string) (*Document, error)

Analyzed creates a new analyzed spec document

func Embedded ¶

func Embedded(orig, flat json.RawMessage) (*Document, error)

Embedded returns a Document based on embedded specs. No analysis is required

func JSONSpec ¶

func JSONSpec(path string) (*Document, error)

JSONSpec loads a spec from a json document

func Spec ¶

func Spec(path string) (*Document, error)

Spec loads a new spec document

func (*Document) BasePath ¶

func (d *Document) BasePath() string

BasePath the base path for this spec

func (*Document) Expanded ¶

func (d *Document) Expanded(options ...*spec.ExpandOptions) (*Document, error)

Expanded expands the ref fields in the spec document and returns a new spec document

func (*Document) Host ¶

func (d *Document) Host() string

Host returns the host for the API

func (*Document) OrigSpec ¶

func (d *Document) OrigSpec() *spec.Swagger

OrigSpec yields the original spec

func (*Document) Pristine ¶

func (d *Document) Pristine() *Document

Pristine creates a new pristine document instance based on the input data

func (*Document) Raw ¶

func (d *Document) Raw() json.RawMessage

Raw returns the raw swagger spec as json bytes

func (*Document) ResetDefinitions ¶

func (d *Document) ResetDefinitions() *Document

ResetDefinitions gives a shallow copy with the models reset

func (*Document) Schema ¶

func (d *Document) Schema() *spec.Schema

Schema returns the swagger 2.0 schema

func (*Document) Spec ¶

func (d *Document) Spec() *spec.Swagger

Spec returns the swagger spec object model

func (*Document) SpecFilePath ¶

func (d *Document) SpecFilePath() string

SpecFilePath returns the file path of the spec if one is defined

func (*Document) Version ¶

func (d *Document) Version() string

Version returns the version of this spec

Source Files ¶

doc.go spec.go

Directories ¶