request

Documentation

Index

• Variables
• type Auth
  • func NewAuth(t *Template) (Auth, error)
• type AuthBase
• type AuthType
• type BasicAuth
  • func NewBasicAuth(t *Template) (*BasicAuth, error)
  • func (a *BasicAuth) Apply(r *http.Request)
  • func (a *BasicAuth) GetType() AuthType
• type BearerAuth
  • func NewBearerAuth(t *Template) (*BearerAuth, error)
  • func (a *BearerAuth) Apply(r *http.Request)
  • func (a *BearerAuth) GetType() AuthType
• type ByteBody
  • func (b *ByteBody) UnmarshalJSON(data []byte) error
  • func (b *ByteBody) UnmarshalYAML(value *yaml.Node) error
• type Request
  • func LoadRequest(itemPath string) (*Request, error)
  • func NewRequest(data RequestData) Request
  • func (r *Request) ToHttpRequest() (*http.Request, error)
• type RequestData
• type StringOrStringList
  • func (s *StringOrStringList) UnmarshalJSON(data []byte) error
  • func (s *StringOrStringList) UnmarshalYAML(value *yaml.Node) error
• type Template
  • func NewTemplate(templatePath string) (*Template, error)
  • func (t *Template) Interpolate(vars map[string]string, useEnv bool) *Template
  • func (t *Template) Parse() (*Request, error)

Variables

var ErrTemplateParse = errors.New("failed to parse template")

Types

type Auth

type Auth interface {
	Apply(r *http.Request)
	GetType() AuthType
}

func NewAuth

func NewAuth(t *Template) (Auth, error)

type AuthBase

type AuthBase struct {
	Type AuthType `json:"type" yaml:"type"`
}

type AuthType

type AuthType string

const (
	Basic  AuthType = "basic"
	Bearer AuthType = "bearer"
)

type BasicAuth

type BasicAuth struct {
	Username string `json:"username" yaml:"username"`
	Password string `json:"password" yaml:"password"`
}

func NewBasicAuth

func NewBasicAuth(t *Template) (*BasicAuth, error)

func (*BasicAuth) Apply

func (a *BasicAuth) Apply(r *http.Request)

func (*BasicAuth) GetType

func (a *BasicAuth) GetType() AuthType

type BearerAuth

type BearerAuth struct {
	Token string `json:"token"`
}

func NewBearerAuth

func NewBearerAuth(t *Template) (*BearerAuth, error)

func (*BearerAuth) Apply

func (a *BearerAuth) Apply(r *http.Request)

func (*BearerAuth) GetType

func (a *BearerAuth) GetType() AuthType

type ByteBody

type ByteBody []byte

func (*ByteBody) UnmarshalJSON

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

func (*ByteBody) UnmarshalYAML

func (b *ByteBody) UnmarshalYAML(value *yaml.Node) error

type Request

type Request struct {
	Method  string
	Path    string
	Body    []byte
	Headers map[string]StringOrStringList
}

func LoadRequest

func LoadRequest(itemPath string) (*Request, error)

func NewRequest

func NewRequest(data RequestData) Request

func (*Request) ToHttpRequest

func (r *Request) ToHttpRequest() (*http.Request, error)

type RequestData

type RequestData struct {
	Method  string                        `json:"method" yaml:"method"`
	Path    string                        `json:"path" yaml:"path"`
	Body    ByteBody                      `json:"body" yaml:"body"`
	Headers map[string]StringOrStringList `json:"headers" yaml:"headers"`
}

type StringOrStringList

type StringOrStringList []string

func (*StringOrStringList) UnmarshalJSON

func (s *StringOrStringList) UnmarshalJSON(data []byte) error

func (*StringOrStringList) UnmarshalYAML

func (s *StringOrStringList) UnmarshalYAML(value *yaml.Node) error

type Template

type Template string

func NewTemplate

func NewTemplate(templatePath string) (*Template, error)

func (*Template) Interpolate

func (t *Template) Interpolate(vars map[string]string, useEnv bool) *Template

func (*Template) Parse

func (t *Template) Parse() (*Request, error)