rest

Documentation

Index

• type Client
  • func (c *Client) Get(function string, params map[string]string) ([]byte, error)
  • func (c *Client) PostFile(function string, fileParameterName string, filename string, ...) ([]byte, error)
  • func (c *Client) PostJSON(function string, json []byte) ([]byte, error)
  • func (c *Client) PostRequest(function string, params map[string]string) ([]byte, error)
  • func (c *Client) PostRequestRaw(function string, params map[string]interface{}) ([]byte, error)
• type ClientCtor
  • func NewClient(endpoint string) ClientCtor

Types

type Client

type Client struct {
	BaseEndpoint string
}

Client represents a basic REST client.

func (*Client) Get

func (c *Client) Get(function string, params map[string]string) ([]byte, error)

Get performs a get using the provided params as query string parameters.

func (*Client) PostFile

func (c *Client) PostFile(function string, fileParameterName string, filename string, params map[string]string) ([]byte, error)

PostFile submits a file in a POST request using a multipart form.

func (*Client) PostJSON

func (c *Client) PostJSON(function string, json []byte) ([]byte, error)

PostJSON posts json data to a URI.

func (*Client) PostRequest

func (c *Client) PostRequest(function string, params map[string]string) ([]byte, error)

PostRequest submits a post request with the provided parameters.

func (*Client) PostRequestRaw

func (c *Client) PostRequestRaw(function string, params map[string]interface{}) ([]byte, error)

PostRequestRaw submits a post request with the provided parameters submitted as a raw string.

type ClientCtor

type ClientCtor func() *Client

ClientCtor repressents a client constructor to instantiate a rest client.

func NewClient

func NewClient(endpoint string) ClientCtor

NewClient instantiates and returns a new REST client constructor.