apiclient

README

-apiClient-go

Standardised API Client package

-apiClient-go is part of the kiss-my-package set used by apps like FaceMasq, PaperBag, Celestial, Executrix, and more

Documentation

Index

• Constants
• type APIClient
  • func Prepare() *APIClient
  • func (client *APIClient) ClearLooseCookies()
  • func (client *APIClient) Do(ctx context.Context, request *Request) (*Response, error)
• type Auth
• type BodyParams
• type Headers
• type Request
• type Response
• type URLParams

Constants

const ErrorThreshold = 300

Types

type APIClient

type APIClient struct {
	Engine       http.Client
	LooseCookies []*http.Cookie
}

func Prepare

func Prepare() *APIClient

Prepare sets-up the client used in Do().

func (*APIClient) ClearLooseCookies

func (client *APIClient) ClearLooseCookies()

func (*APIClient) Do

func (client *APIClient) Do(ctx context.Context, request *Request) (*Response, error)

Do creates a http.Request from an Request and executes the request.

type Auth

type Auth struct {
	Type     string
	Username string
	Password string
}

Auth is a struct used to store the parameters of the request authentication values.

type BodyParams

type BodyParams map[string]string

BodyParams is a map of strings, with a string key, used to store the parameters of the request body.

type Headers

type Headers map[string]string

Headers is a map of strings, with a string key, used to store the parameters of the request headers.

type Request

type Request struct {
	URL             string
	Method          string
	EndPoint        string
	EndPointParams  URLParams
	DynamicEndPoint bool
	Headers         Headers
	Path            []string
	Query           url.Values
	Body            BodyParams
	BodyJSON        io.Reader
	Auth            Auth
	BodyText        string
	Cookies         []*http.Cookie
}

Request is a struct used to store the collective data of the API/Web Request used by Do() and Build().

type Response

type Response struct {
	*http.Response
	Body    string
	Cookies string
}

type URLParams

type URLParams map[string]string

URLParams is a map of strings, with a string key, used to store the parameters of the request url.