parser

package

v1.7.0 Latest Latest Go to latest Published: Oct 11, 2018 License: MIT Imports: 15 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

Package parser is an API blueprint parser and renderer

This section is empty.

This section is empty.

func Load(name string, engine Parser) (*api.API, error)

Load reads API blueprint from file as blueprint.API struct using selected Parser

func LoadAsJSON(name string, engine Parser) ([]byte, error)

LoadAsJSON reads API blueprint from file as API Element JSON using selected Parser

func Parse(r io.Reader, engine Parser) (*api.API, error)

Parse formats API blueprint as blueprint.API struct using selected Parser

func ParseAsJSON(r io.Reader, engine Parser) ([]byte, error)

ParseAsJSON parse API blueprint as API Element JSON

func Read(name string) ([]byte, error)

Read reads API blueprint from file as bytes

func Seeds(name string) []string

Seeds lists filenames of API blueprint's seeds.

func Validate(r io.Reader, engine Parser) (*api.API, error)

Validate validates API blueprint using selected Parser

type Parser interface {
	Parse(r io.Reader) ([]byte, error)
	Validate(r io.Reader) ([]byte, error)
	Version() string
}