parser

Documentation

Overview

Package snowboard API blueprint parser and renderer

Index

• func HTML(tpl string, w io.Writer, b *api.API) error
• func Load(name string, engine Parser) (*api.API, error)
• func MockHandler(ms MockTransactions) http.Handler
• func Parse(r io.Reader, engine Parser) (*api.API, error)
• func Read(name string) ([]byte, error)
• func Validate(r io.Reader, engine Parser) (*api.API, error)
• type MockTransaction
  • func Mock(b *api.API) []*MockTransaction
• type MockTransactions
  • func (ms MockTransactions) Router() *mockRouter
• type Parser

Functions

func HTML

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

HTML renders blueprint.API struct as HTML document

func Load

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

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

func MockHandler

func MockHandler(ms MockTransactions) http.Handler

func Parse

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

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

func Read

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

Read reads API blueprint from file as bytes

func Validate

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

Validate validates API blueprint using selected Parser

Types

type MockTransaction

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

func Mock

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

type MockTransactions

type MockTransactions []*MockTransaction

func (MockTransactions) Router

func (ms MockTransactions) Router() *mockRouter

type Parser

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