spec

Documentation

Index

• Variables
• type Body
  • func (b *Body) UnmarshalJSON(data []byte) error
• type Expect
• type Export
• type Loader
  • func NewSpecLoader(filereader file.Reader) Loader
• type Request
• type Spec
  • func Unmarshal(data []byte) (Spec, error)
• type Step

Variables

var (
	ErrNoFilesFound error = errors.New("no_files_found")
	ErrInvalidSpec  error = errors.New("invalid_spec_format")
)

Types

type Body

type Body string

func (*Body) UnmarshalJSON

func (b *Body) UnmarshalJSON(data []byte) error

type Expect

type Expect struct {
	Code    *validator.StatusCodeValidator `json:"code"`
	Headers *validator.HeaderValidator     `json:"headers"`
	Body    *validator.BodyValidator       `json:"body"`
}

type Export

type Export map[string]string

type Loader

type Loader interface {
	Load(string) []Spec
}

func NewSpecLoader

func NewSpecLoader(filereader file.Reader) Loader

type Request

type Request struct {
	Type    string            `json:"method"`
	URL     string            `json:"url"`
	Headers map[string]string `json:"headers"`
	Body    Body              `json:"body"`
}

type Spec

type Spec struct {
	Name  string `json:"name"`
	Steps []Step `json:"steps"`
}

func Unmarshal

func Unmarshal(data []byte) (Spec, error)

type Step

type Step struct {
	Name    string  `json:"name"`
	Request Request `json:"request"`
	Expect  Expect  `json:"expect"`
	Export  Export  `json:"export"`
}