reqKit

Documentation

Index

• Constants
• Variables
• func Get(ctx context.Context, url string, queryParams map[string][]string) *req.Response
• func GetAndInto(ctx context.Context, url string, queryParams map[string][]string, ...) error
• func GetGlobalClient() (client *req.Client)
• func NewClient(options ...ClientOption) (client *req.Client)
• func Post(ctx context.Context, url string, body interface{}) *req.Response
• func PostAndInto(ctx context.Context, url string, body interface{}, v interface{}) error
• func ReplaceGlobalClient(client *req.Client)
• func SimpleGet(ctx context.Context, url string) *req.Response
• type ClientOption
  • func WithCommonErrorResult(result interface{}) ClientOption
  • func WithDev() ClientOption
  • func WithInsecureSkipVerify(insecureSkipVerify bool) ClientOption
  • func WithLogger(logger req.Logger) ClientOption
  • func WithOnAfterResponse(middleware req.ResponseMiddleware) ClientOption
  • func WithRetryConditions(conditions ...req.RetryConditionFunc) ClientOption
  • func WithRetryCount(retryCount int) ClientOption
  • func WithRetryHooks(hooks ...req.RetryHookFunc) ClientOption
  • func WithRetryInterval(getRetryInterval req.GetRetryIntervalFunc) ClientOption
  • func WithTimeout(timeout time.Duration) ClientOption

Constants

const (
	ContentTypePlainText = "text/plain; charset=utf-8"

	ContentTypeJson = "application/json; charset=utf-8"

	ContentTypeXml = "text/xml; charset=utf-8"

	ContentTypeForm = "application/x-www-form-urlencoded; charset=utf-8"
)

const (
	// DefaultTimeout 默认超时时间
	DefaultTimeout = time.Second * 30
)

Variables

var (
	NewLogger func(output io.Writer, prefix string, flag int) req.Logger = req.NewLogger

	NewLoggerFromStandardLogger func(l *log.Logger) req.Logger = req.NewLoggerFromStandardLogger
)

Functions

func Get

func Get(ctx context.Context, url string, queryParams map[string][]string) *req.Response

Get

PS: 要注意 req.Response 结构体的 Err 字段.

@param queryParams 可以为nil

func GetAndInto

func GetAndInto(ctx context.Context, url string, queryParams map[string][]string, v interface{}) error

func GetGlobalClient

func GetGlobalClient() (client *req.Client)

func NewClient

func NewClient(options ...ClientOption) (client *req.Client)

NewClient

@param options 不传参的情况下， (1) 生产模式

(2) 超时时间: 30s
(3) 跳过https证书验证
(4) 日志输出: os.Stdout
(5) 不重试

func Post

func Post(ctx context.Context, url string, body interface{}) *req.Response

Post TODO: 待验证.

PS: 要注意 req.Response 结构体的 Err 字段.

@param body Set the request Body, accepts string、[]byte、io.Reader、map and struct.

func PostAndInto

func PostAndInto(ctx context.Context, url string, body interface{}, v interface{}) error

func ReplaceGlobalClient

func ReplaceGlobalClient(client *req.Client)

func SimpleGet

func SimpleGet(ctx context.Context, url string) *req.Response

Types

type ClientOption

type ClientOption func(*clientOptions)

func WithCommonErrorResult

func WithCommonErrorResult(result interface{}) ClientOption

func WithDev

func WithDev() ClientOption

func WithInsecureSkipVerify

func WithInsecureSkipVerify(insecureSkipVerify bool) ClientOption

func WithLogger

func WithLogger(logger req.Logger) ClientOption

WithLogger

@param logger (1) 可以是 *logrus.Logger 实例 || *zap.SugaredLogger 实例

(2) 可以为nil（disable log, 禁用输出）

func WithOnAfterResponse

func WithOnAfterResponse(middleware req.ResponseMiddleware) ClientOption

func WithRetryConditions

func WithRetryConditions(conditions ...req.RetryConditionFunc) ClientOption

func WithRetryCount

func WithRetryCount(retryCount int) ClientOption

func WithRetryHooks

func WithRetryHooks(hooks ...req.RetryHookFunc) ClientOption

func WithRetryInterval

func WithRetryInterval(getRetryInterval req.GetRetryIntervalFunc) ClientOption

func WithTimeout

func WithTimeout(timeout time.Duration) ClientOption