api_client

Documentation

Index

• Constants
• Variables
• type APIClient
  • func NewHTTPAPIClient(url string, apiHeaderName string, timeout time.Duration) APIClient
• type HTTPAPIClient
  • func (p *HTTPAPIClient) Call(apiName string, payload spirit.Payload, v interface{}) (err error)
  • func (p *HTTPAPIClient) Cast(apiName string, payload spirit.Payload)
• type JsonPayload

Constants

const (
	HeaderForwardedPayload = "X-Forwarded-Payload"
)

const (
	HttpJsonApiErrNamespace = "JSON_APIClient"
)

Variables

var (
	ErrAPINameIsEmpty                   = errors.TN(JsonApiClientErrorNamespace, 1, "api name is empty")
	ErrAPIClientSendFailed              = errors.TN(JsonApiClientErrorNamespace, 2, "api client send failed, api: {{.api}}, url: {{.url}}")
	ErrAPIClientResponseUnmarshalFailed = errors.TN(JsonApiClientErrorNamespace, 3, "api response unmarshal failed, api: {{.api}}, url: {{.url}}")

	ErrAPIClientReadResponseBodyFailed = errors.TN(JsonApiClientErrorNamespace, 4, "read api response body failed, api is: {{.api}}")
	ErrAPIClientBadStatusCode          = errors.TN(JsonApiClientErrorNamespace, 5, "bad response status code, api is: {{.api}}, code is: {{.code}}")
	ErrAPIClientCreateNewRequestFailed = errors.TN(JsonApiClientErrorNamespace, 6, "create new request failed")

	ErrUnknownPayloadError = errors.TN(JsonApiClientErrorNamespace, 7, "")
)

var (
	DefaultClientTimeout = time.Second * 30
)

var JsonApiClientErrorNamespace = "APIClient"

Types

type APIClient

type APIClient interface {
	Call(apiName string, payload spirit.Payload, v interface{}) (err error)
	Cast(apiName string, payload spirit.Payload)
}

func NewHTTPAPIClient

func NewHTTPAPIClient(url string, apiHeaderName string, timeout time.Duration) APIClient

type HTTPAPIClient

type HTTPAPIClient struct {
	// contains filtered or unexported fields
}

func (*HTTPAPIClient) Call

func (p *HTTPAPIClient) Call(apiName string, payload spirit.Payload, v interface{}) (err error)

func (*HTTPAPIClient) Cast

func (p *HTTPAPIClient) Cast(apiName string, payload spirit.Payload)

type JsonPayload

type JsonPayload struct {
	Id      string          `json:"id"`
	Data    interface{}     `json:"data"`
	Errors  []*spirit.Error `json:"errors"`
	Context spirit.Map      `json:"context"`
}