parser

package

v0.5.0 Latest Latest Go to latest Published: Jan 12, 2017 License: MIT Imports: 18 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 snowboard API blueprint parser and renderer

This section is empty.

This section is empty.

func HTML(tpl string, w io.Writer, b *api.API) error

HTML renders blueprint.API struct as HTML document

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

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

func MockHandler(ms MockTransactions) http.Handler

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

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

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

Read reads API blueprint from file as bytes

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

Validate validates API blueprint using selected Parser

type MockTransaction struct {
	Path        string
	Method      string
	StatusCode  int
	ContentType string
	Body        string
}

func Mock(b *api.API) []*MockTransaction

type MockTransactions []*MockTransaction

func (ms MockTransactions) Router() *mockRouter

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