schema

Documentation

Index

• type Handler
  • func (h Handler) ContentType() string
• type Request
• type Response
  • func (r Response) ContentType() string
• type Schema
  • func Parse(r io.Reader) (Schema, error)
• type Server

Types

type Handler

type Handler struct {
	Name      string            `yaml:"name"`
	Method    string            `yaml:"method"`
	Path      string            `yaml:"path"`
	Headers   map[string]string `yaml:"headers"`
	Requests  []Request         `yaml:"requests"`
	Responses []Response        `yaml:"responses"`
}

func (Handler) ContentType

func (h Handler) ContentType() string

type Request

type Request struct {
	Name     string `yaml:"name"`
	BodyFile string `yaml:"body"`
}

type Response

type Response struct {
	Name        string            `yaml:"name"`
	Description string            `yaml:"description"`
	StatusCode  int               `yaml:"status_code"`
	Headers     map[string]string `yaml:"headers"`
	Body        string            `yaml:"body"`
}

func (Response) ContentType

func (r Response) ContentType() string

type Schema

type Schema struct {
	Version int    `yaml:"version"`
	Server  Server `yaml:"server"`
}

func Parse

func Parse(r io.Reader) (Schema, error)

type Server

type Server struct {
	BaseURL  string    `yaml:"base_url"`
	Handlers []Handler `yaml:"handlers"`
}