gottp

README

Gottp Http Client

Gottp is a wrapper over the base http's client functionality written in go, providing additional features like tracing and resilience

Note: This version is built with the github.com/mailru/easyjson package or similar packages in mind and requires for the request and response bodies to implement the IRequest and IResponse interfaces respectively, visit the versions/base branch to see a version that does not rely on this and uses the encoding/* packages instead

Installation

1. Install module

go get github.com/betalixt/gottp

1. Import

import "github.com/betalixt/gottp" 

TODO

• Handle Form Data with files
• Benchmarking and optimizations
• Further Documentation

Documentation

Index

• type ClientOptions
  • func DefaultOptions() *ClientOptions
• type HttpClient
  • func NewHttpClientProvider(tracer ITracer, headers map[string]string) *HttpClient
  • func NewHttpClientWithClientProvider(client IInternalClient, tracer ITracer, headers map[string]string, tid string, ...) *HttpClient
  • func (HttpClient *HttpClient) Delete(ctx context.Context, headers map[string]string, endpoint string, ...) (*Response, error)
  • func (HttpClient *HttpClient) DeleteBody(ctx context.Context, headers map[string]string, body IJsonDTO, endpoint string, ...) (*Response, error)
  • func (HttpClient *HttpClient) DeleteForm(ctx context.Context, headers map[string]string, form url.Values, ...) (*Response, error)
  • func (HttpClient *HttpClient) DeleteXml(ctx context.Context, headers map[string]string, body interface{}, ...) (*Response, error)
  • func (HttpClient *HttpClient) Get(ctx context.Context, headers map[string]string, endpoint string, ...) (*Response, error)
  • func (HttpClient *HttpClient) Patch(ctx context.Context, headers map[string]string, endpoint string, ...) (*Response, error)
  • func (HttpClient *HttpClient) PatchBody(ctx context.Context, headers map[string]string, body IJsonDTO, endpoint string, ...) (*Response, error)
  • func (HttpClient *HttpClient) PatchForm(ctx context.Context, headers map[string]string, form url.Values, ...) (*Response, error)
  • func (HttpClient *HttpClient) PatchXml(ctx context.Context, headers map[string]string, body interface{}, ...) (*Response, error)
  • func (HttpClient *HttpClient) Post(ctx context.Context, headers map[string]string, endpoint string, ...) (*Response, error)
  • func (HttpClient *HttpClient) PostBody(ctx context.Context, headers map[string]string, body IJsonDTO, endpoint string, ...) (*Response, error)
  • func (HttpClient *HttpClient) PostForm(ctx context.Context, headers map[string]string, form url.Values, ...) (*Response, error)
  • func (HttpClient *HttpClient) PostXml(ctx context.Context, headers map[string]string, body interface{}, ...) (*Response, error)
  • func (HttpClient *HttpClient) Put(ctx context.Context, headers map[string]string, endpoint string, ...) (*Response, error)
  • func (HttpClient *HttpClient) PutBody(ctx context.Context, headers map[string]string, body IJsonDTO, endpoint string, ...) (*Response, error)
  • func (HttpClient *HttpClient) PutForm(ctx context.Context, headers map[string]string, form url.Values, ...) (*Response, error)
  • func (HttpClient *HttpClient) PutXml(ctx context.Context, headers map[string]string, body interface{}, ...) (*Response, error)
  • func (client *HttpClient) WithOptions(optn *ClientOptions) *HttpClient
• type IInternalClient
• type IJsonDTO
• type ITracer
• type Response
  • func (resp *Response) Unmarshal(data IJsonDTO) error
  • func (resp *Response) UnmarshalXml(data interface{}) error
• type RetryPolicy

Types

type ClientOptions

type ClientOptions struct {
	Retry RetryPolicy
}

func DefaultOptions

func DefaultOptions() *ClientOptions

type HttpClient

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

func NewHttpClientProvider

func NewHttpClientProvider(
	tracer ITracer,
	headers map[string]string,
) *HttpClient

- "Constructors"

func NewHttpClientWithClientProvider

func NewHttpClientWithClientProvider(
	client IInternalClient,
	tracer ITracer,
	headers map[string]string,
	tid string,
	pid string,
	flg string,
) *HttpClient

func (*HttpClient) Delete

func (HttpClient *HttpClient) Delete(
	ctx context.Context,
	headers map[string]string,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) DeleteBody

func (HttpClient *HttpClient) DeleteBody(
	ctx context.Context,
	headers map[string]string,
	body IJsonDTO,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) DeleteForm

func (HttpClient *HttpClient) DeleteForm(
	ctx context.Context,
	headers map[string]string,
	form url.Values,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) DeleteXml

func (HttpClient *HttpClient) DeleteXml(
	ctx context.Context,
	headers map[string]string,
	body interface{},
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) Get

func (HttpClient *HttpClient) Get(
	ctx context.Context,
	headers map[string]string,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) Patch

func (HttpClient *HttpClient) Patch(
	ctx context.Context,
	headers map[string]string,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) PatchBody

func (HttpClient *HttpClient) PatchBody(
	ctx context.Context,
	headers map[string]string,
	body IJsonDTO,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) PatchForm

func (HttpClient *HttpClient) PatchForm(
	ctx context.Context,
	headers map[string]string,
	form url.Values,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) PatchXml

func (HttpClient *HttpClient) PatchXml(
	ctx context.Context,
	headers map[string]string,
	body interface{},
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) Post

func (HttpClient *HttpClient) Post(
	ctx context.Context,
	headers map[string]string,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) PostBody

func (HttpClient *HttpClient) PostBody(
	ctx context.Context,
	headers map[string]string,
	body IJsonDTO,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) PostForm

func (HttpClient *HttpClient) PostForm(
	ctx context.Context,
	headers map[string]string,
	form url.Values,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) PostXml

func (HttpClient *HttpClient) PostXml(
	ctx context.Context,
	headers map[string]string,
	body interface{},
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) Put

func (HttpClient *HttpClient) Put(
	ctx context.Context,
	headers map[string]string,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) PutBody

func (HttpClient *HttpClient) PutBody(
	ctx context.Context,
	headers map[string]string,
	body IJsonDTO,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) PutForm

func (HttpClient *HttpClient) PutForm(
	ctx context.Context,
	headers map[string]string,
	form url.Values,
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) PutXml

func (HttpClient *HttpClient) PutXml(
	ctx context.Context,
	headers map[string]string,
	body interface{},
	endpoint string,
	qParam map[string][]string,
	params ...string,
) (*Response, error)

func (*HttpClient) WithOptions

func (client *HttpClient) WithOptions(
	optn *ClientOptions,
) *HttpClient

type IInternalClient

type IInternalClient interface {
	Do(*http.Request) (*http.Response, error)
}

type IJsonDTO

type IJsonDTO interface {
	MarshalJSON() ([]byte, error)
	UnmarshalJSON([]byte) error
}

type ITracer

type ITracer interface {
	ExtractTraceInfo(
		ctx context.Context,
	) (ver, tid, pid, rid, flg string)
	TraceDependency(
		ctx context.Context,
		spanId string,
		dependencyType string,
		serviceName string,
		commandName string,
		success bool,
		startTimestamp time.Time,
		eventTimestamp time.Time,
		fields map[string]string,
	)
}

type Response

type Response http.Response

func (*Response) Unmarshal

func (resp *Response) Unmarshal(data IJsonDTO) error

func (*Response) UnmarshalXml

func (resp *Response) UnmarshalXml(data interface{}) error

type RetryPolicy

type RetryPolicy struct {
	Enabled        bool
	RetriableCodes []int
	RetryCount     int
	InitialBackoff time.Duration
}