xhttp

README

xhttp

http request library for Go

---

鸣谢

GoLand A Go IDE with extended support for JavaScript, TypeScript, and Databases。

特别感谢 JetBrains 为开源项目提供免费的 GoLand 等 IDE 的授权

Copyright © 2000-2024 JetBrains s.r.o. JetBrains and the JetBrains logo are registered trademarks of JetBrains s.r.o.

Documentation

Index

• Constants
• func ConvertToString(v any) (str string)
• func FormatURLParam(body map[string]any) (urlParam string)
• type Client
  • func NewClient() (client *Client)
  • func (c *Client) Req(typeStr ...string) *Request
  • func (c *Client) SetBodySize(sizeMB int) (client *Client)
  • func (c *Client) SetHttpTLSConfig(tlsCfg *tls.Config) (client *Client)
  • func (c *Client) SetHttpTransport(transport *http.Transport) (client *Client)
  • func (c *Client) SetTimeout(timeout time.Duration) (client *Client)
  • func (c *Client) SetTransport(transport http.RoundTripper) (client *Client)
• type Request
  • func (r *Request) Delete(url string) *Request
  • func (r *Request) EndBytes(ctx context.Context) (res *http.Response, bs []byte, err error)
  • func (r *Request) EndStruct(ctx context.Context, v any) (res *http.Response, err error)
  • func (r *Request) Get(url string) *Request
  • func (r *Request) Patch(url string) *Request
  • func (r *Request) Post(url string) *Request
  • func (r *Request) Put(url string) *Request
  • func (r *Request) SendBodyMap(bm map[string]any) (client *Request)
  • func (r *Request) SendMultipartBodyMap(bm map[string]any) (client *Request)
  • func (r *Request) SendString(encodeStr string) (client *Request)
  • func (r *Request) SendStruct(v any) (c *Request)

Constants

const (
	GET    = "GET"
	POST   = "POST"
	PUT    = "PUT"
	DELETE = "DELETE"
	PATCH  = "PATCH"

	ResTypeJSON = "json"
	ResTypeXML  = "xml"

	TypeJSON              = "json"
	TypeXML               = "xml"
	TypeFormData          = "form-data"
	TypeMultipartFormData = "multipart-form-data"
)

Functions

func ConvertToString

func ConvertToString(v any) (str string)

func FormatURLParam

func FormatURLParam(body map[string]any) (urlParam string)

Types

type Client

type Client struct {
	HttpClient *http.Client
	// contains filtered or unexported fields
}

func NewClient

func NewClient() (client *Client)

NewClient , default tls.Config{InsecureSkipVerify: true}

func (*Client) Req

func (c *Client) Req(typeStr ...string) *Request

typeStr is request type and response type default is TypeJSON first param is request type second param is response data type

func (*Client) SetBodySize

func (c *Client) SetBodySize(sizeMB int) (client *Client)

set body size (MB), default is 10MB

func (*Client) SetHttpTLSConfig

func (c *Client) SetHttpTLSConfig(tlsCfg *tls.Config) (client *Client)

func (*Client) SetHttpTransport

func (c *Client) SetHttpTransport(transport *http.Transport) (client *Client)

func (*Client) SetTimeout

func (c *Client) SetTimeout(timeout time.Duration) (client *Client)

func (*Client) SetTransport

func (c *Client) SetTransport(transport http.RoundTripper) (client *Client)

type Request

type Request struct {
	Header http.Header
	// contains filtered or unexported fields
}

func (*Request) Delete

func (r *Request) Delete(url string) *Request

func (*Request) EndBytes

func (r *Request) EndBytes(ctx context.Context) (res *http.Response, bs []byte, err error)

func (*Request) EndStruct

func (r *Request) EndStruct(ctx context.Context, v any) (res *http.Response, err error)

func (*Request) Get

func (r *Request) Get(url string) *Request

func (*Request) Patch

func (r *Request) Patch(url string) *Request

func (*Request) Post

func (r *Request) Post(url string) *Request

func (*Request) Put

func (r *Request) Put(url string) *Request

func (*Request) SendBodyMap

func (r *Request) SendBodyMap(bm map[string]any) (client *Request)

func (*Request) SendMultipartBodyMap

func (r *Request) SendMultipartBodyMap(bm map[string]any) (client *Request)

func (*Request) SendString

func (r *Request) SendString(encodeStr string) (client *Request)

encodeStr: url.Values.Encode() or jsonBody

func (*Request) SendStruct

func (r *Request) SendStruct(v any) (c *Request)