parser

Documentation

Overview

Package parser is an API blueprint parser and renderer

Index

• func Load(name string, engine Parser) (*api.API, error)
• func LoadAsJSON(name string, engine Parser) ([]byte, error)
• func Parse(r io.Reader, engine Parser) (*api.API, error)
• func ParseAsJSON(r io.Reader, engine Parser) ([]byte, error)
• func Read(name string) ([]byte, error)
• func Seeds(name string) []string
• func Validate(r io.Reader, engine Parser) (*api.API, error)
• type Parser

Functions

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 LoadAsJSON

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

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

func Parse

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

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

func ParseAsJSON

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

ParseAsJSON parse API blueprint as API Element JSON

func Read

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

Read reads API blueprint from file as bytes

func Seeds

func Seeds(name string) []string

Seeds lists filenames of API blueprint's seeds.

func Validate

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

Validate validates API blueprint using selected Parser

Types

type Parser

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