httpclient

Documentation

Overview

Package httpclient provides http client used for SDK.

Index

• type Client
  • func New(config Config) *Client
  • func (c *Client) Get(ctx context.Context, path string, in, out interface{}) error
  • func (c *Client) Request(ctx context.Context, req, res interface{}) error
• type Config
• type DefaultHandler
  • func NewDefaultHandler(logger *glog.Logger, rawRump bool) *DefaultHandler
  • func (h DefaultHandler) HandleResponse(ctx context.Context, res *gclient.Response, out interface{}) error
• type Handler

Types

type Client

type Client struct {
	*gclient.Client
	Handler
}

Client is a http client for SDK.

func New

func New(config Config) *Client

New creates and returns a http client for SDK.

func (*Client) Get

func (c *Client) Get(ctx context.Context, path string, in, out interface{}) error

Get sends a request using GET method.

func (*Client) Request

func (c *Client) Request(ctx context.Context, req, res interface{}) error

Request sends request to service by struct object `req`, and receives response to struct object `res`.

type Config

type Config struct {
	URL     string          `v:"required"` // Service address. Eg: user.svc.local, http://user.svc.local
	Client  *gclient.Client // Custom underlying client.
	Handler Handler         // Custom response handler.
	Logger  *glog.Logger    // Custom logger.
	RawDump bool            // Whether auto dump request&response in stdout.
}

Config is the configuration struct for SDK client.

type DefaultHandler

type DefaultHandler struct {
	Logger  *glog.Logger
	RawDump bool
}

DefaultHandler handle ghttp.DefaultHandlerResponse of json format.

func NewDefaultHandler

func NewDefaultHandler(logger *glog.Logger, rawRump bool) *DefaultHandler

func (DefaultHandler) HandleResponse

func (h DefaultHandler) HandleResponse(ctx context.Context, res *gclient.Response, out interface{}) error

type Handler

type Handler interface {
	// HandleResponse handles the http response and transforms its body to the specified object.
	// The parameter `out` specifies the object that the response body is transformed to.
	HandleResponse(ctx context.Context, res *gclient.Response, out interface{}) error
}

Handler is the interface for http response handling.