builder

package module

v0.0.3 Latest Latest Go to latest Published: Nov 28, 2023 License: MIT Imports: 20 Imported by: 3

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/catnovelapi/builder

Links

Open Source Insights

README ¶

Here is a generated GitHub README.md based on the provided Go code:

Go HTTP Client Builder

Go HTTP Client Builder is a Go package for building HTTP clients with fluent interface. It provides an easy way to configure HTTP requests and handle responses.

Installation

go get github.com/catnovel/builder

Usage

Create a new client

client := builder.NewClient()

Configure the client

client.SetBaseUrl("https://api.example.com")
       .SetTimeout(30)
       .SetUserAgent("my-app/1.0")

Make a request

req := client.R()
resp, err := req.Get("/users")

Handle response

if err != nil {
  // handle error
}

fmt.Println(resp.GetStatusCode())
fmt.Println(resp.String())

Post form data

req.SetFormData(map[string]string{
  "name": "John",
  "email": "john@email.com", 
})

resp, err := req.Post("/users")

Request builder

The R() method creates a new Request object that can be used to configure an HTTP request.

Set request body

req.SetBody(map[string]interface{}{
  "name": "John",
  "age": 30,
})

Supports body types: string, []byte, map[string]interface{}, etc.

Set request headers

req.SetHeader("Content-Type", "application/json")
   .SetHeader("Authorization", "Bearer token")

Set query parameters

req.SetQueryParam("sort", "desc")
   .SetQueryParam("limit", 100)

Set cookies

req.SetCookies([]*http.Cookie{
  {Name: "session", Value: "1234"},
})

Response builder

The Response object contains the HTTP response and useful methods to handle it.

Get response as string

resp.String()

Get response as JSON

var data struct{}
resp.Json(&data)

Get response as HTML document

doc := resp.Html()

Get response headers

headers := resp.GetHeader()

Full Example

client := builder.NewClient()
req := client.R()

req.SetQueryParam("page", 1)
   .SetHeader("Authorization", "token")

resp, err := req.Get("/users")

if err != nil {
  // handle error 
}

var result []User
resp.Json(&result)

Contributing

Pull requests are welcome. Feel free to open an issue for any bugs or feature requests.

License

This project is licensed under the MIT License - see the LICENSE file for details.

Documentation ¶

Constants ¶

View Source

const (
	// MethodGet HTTP method
	MethodGet = "GET"

	// MethodPost HTTP method
	MethodPost = "POST"

	// MethodPut HTTP method
	MethodPut = "PUT"

	// MethodDelete HTTP method
	MethodDelete = "DELETE"

	// MethodPatch HTTP method
	MethodPatch = "PATCH"

	// MethodHead HTTP method
	MethodHead = "HEAD"

	// MethodOptions HTTP method
	MethodOptions = "OPTIONS"
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

func NewClient ¶

func NewClient() *Client

NewClient 方法用于创建一个新的 Client 对象, 并返回该对象的指针。

func (*Client) GetClientBaseUrl ¶

func (client *Client) GetClientBaseUrl() string

GetClientBaseUrl 方法用于获取 HTTP 请求的 BaseUrl 部分。它返回一个 string 类型的参数。

func (*Client) GetClientBody ¶

func (client *Client) GetClientBody() interface{}

GetClientBody 方法用于获取 HTTP 请求的 Body 部分。它返回一个 interface{} 类型的参数。

func (*Client) GetClientCookie ¶

func (client *Client) GetClientCookie() string

GetClientCookie 方法用于获取 HTTP 请求的 Cookie 部分。它返回一个 string 类型的参数。

func (*Client) GetClientDebug ¶

func (client *Client) GetClientDebug() bool

GetClientDebug 方法用于获取 HTTP 请求的 Debug 部分。它返回一个 bool 类型的参数。

func (*Client) GetClientDebugFile ¶

func (client *Client) GetClientDebugFile() *os.File

GetClientDebugFile 方法用于获取 HTTP 请求的 DebugFile 部分。它返回一个 *os.File 类型的参数。

func (*Client) GetClientHeaders ¶

func (client *Client) GetClientHeaders() http.Header

GetClientHeaders 方法用于获取 HTTP 请求的 Header 部分。它返回一个 http.Header 类型的参数。

func (*Client) GetClientQueryParams ¶

func (client *Client) GetClientQueryParams() url.Values

GetClientQueryParams 方法用于获取 HTTP 请求的 Query 部分。它返回一个 url.Values 类型的参数。

func (*Client) GetClientQueryParamsEncode ¶

func (client *Client) GetClientQueryParamsEncode() string

GetClientQueryParamsEncode 方法用于获取 HTTP 请求的 Query 部分。它返回一个 Encode 后的 string 类型的参数。

func (*Client) GetClientRetryNumber ¶

func (client *Client) GetClientRetryNumber() int

GetClientRetryNumber 方法用于获取 HTTP 请求的 RetryNumber 部分。它返回一个 int 类型的参数。

func (*Client) GetClientTimeout ¶

func (client *Client) GetClientTimeout() int

GetClientTimeout 方法用于获取 HTTP 请求的 Timeout 部分。它返回一个 int 类型的参数。

func (*Client) R ¶

func (client *Client) R() *Request

R 方法用于创建一个新的 Request 对象。它接收一个 string 类型的参数，该参数表示 HTTP 请求的 Path 部分。

func (*Client) SetBaseURL ¶

func (client *Client) SetBaseURL(baseUrl string) *Client

SetBaseURL 方法用于设置HTTP请求的 BaseUrl 部分。它接收一个 string 类型的参数，该参数表示 BaseUrl 的值。

func (*Client) SetBasicAuth ¶

func (client *Client) SetBasicAuth(username, password string) *Client

SetBasicAuth 方法用于设置 HTTP 请求的 BasicAuth 部分。它接收两个 string 类型的参数，分别表示用户名和密码。

func (*Client) SetCookie ¶

func (client *Client) SetCookie(cookie string) *Client

SetCookie 方法用于设置 HTTP 请求的 Cookie 部分。它接收一个 string 类型的参数，该参数表示 Cookie 的值。

func (*Client) SetCookieJar ¶

func (client *Client) SetCookieJar(cookieJar http.CookieJar) *Client

SetCookieJar 方法用于设置 HTTP 请求的 CookieJar 部分。它接收一个 http.CookieJar 类型的参数，该参数表示 CookieJar 的值。

func (*Client) SetDebug ¶

func (client *Client) SetDebug() *Client

SetDebug 方法用于设置是否输出调试信息,如果调用该方法，那么将输出调试信息。

func (*Client) SetDebugFile ¶

func (client *Client) SetDebugFile(logFileName string) *Client

SetDebugFile 方法用于设置输出调试信息的文件。它接收一个 string 类型的参数，该参数表示文件名。

func (*Client) SetFormDataQueryParams ¶

func (client *Client) SetFormDataQueryParams(params url.Values) *Client

SetFormDataQueryParams 方法用于设置 HTTP 请求的 Query 部分。它接收一个 url.Values 类型的参数，

func (*Client) SetHeader ¶

func (client *Client) SetHeader(key string, value interface{}) *Client

SetHeader 方法用于设置 HTTP 请求的 Header 部分。它接收两个 string 类型的参数，

func (*Client) SetHeaders ¶

func (client *Client) SetHeaders(headers map[string]interface{}) *Client

SetHeaders 方法用于设置 HTTP 请求的 Header 部分。它接收一个 map[string]interface{} 类型的参数，

func (*Client) SetProxy ¶

func (client *Client) SetProxy(proxy string) *Client

SetProxy 方法用于设置 HTTP 请求的 Proxy 部分。它接收一个 string 类型的参数，该参数表示 Proxy 的值。

func (*Client) SetQueryParam ¶

func (client *Client) SetQueryParam(key string, value any) *Client

SetQueryParam 方法用于设置 HTTP 请求的 Query 部分。它接收两个 string 类型的参数，

func (*Client) SetQueryParamString ¶

func (client *Client) SetQueryParamString(query string) *Client

SetQueryParamString 方法用于设置 HTTP 请求的 Query 部分。它接收一个 string 类型的参数，

func (*Client) SetQueryParams ¶

func (client *Client) SetQueryParams(params map[string]any) *Client

SetQueryParams 方法用于设置 HTTP 请求的 Query 部分。它接收一个 map[string]interface{} 类型的参数，

func (*Client) SetRetryNumber ¶

func (client *Client) SetRetryNumber(num int) *Client

SetRetryNumber 方法用于设置重试次数。它接收一个 int 类型的参数，该参数表示重试次数。

func (*Client) SetTimeout ¶

func (client *Client) SetTimeout(timeout int) *Client

SetTimeout 方法用于设置 HTTP 请求的 Timeout 部分, timeout 单位为秒。它接收一个 int 类型的参数，该参数表示 Timeout 的值。

func (*Client) SetUserAgent ¶

func (client *Client) SetUserAgent(userAgent string) *Client

SetUserAgent 方法用于设置 HTTP 请求的 User-Agent 部分。它接收一个 string 类型的参数，该参数表示 User-Agent 的值。

type Request ¶

type Request struct {
	RequestRaw *http.Request // 指向 http.Request 的指针
	// contains filtered or unexported fields
}

func (*Request) Delete ¶

func (request *Request) Delete(url string) (*Response, error)

Delete 方法用于创建一个 DELETE 请求。它接收一个 string 类型的参数，表示 HTTP 请求的路径。

func (*Request) Get ¶

func (request *Request) Get(url string) (*Response, error)

Get 方法用于创建一个 GET 请求。它接收一个 string 类型的参数，表示 HTTP 请求的路径。

func (*Request) GetContentType ¶

func (request *Request) GetContentType() string

GetContentType 方法用于获取 HTTP 请求的 Content-Type 部分的字符串。

func (*Request) GetHost ¶

func (request *Request) GetHost() string

GetHost 方法用于获取 HTTP 请求的 Host 部分的字符串。

func (*Request) GetMethod ¶

func (request *Request) GetMethod() string

GetMethod 方法用于获取 HTTP 请求的 Method 部分的字符串。

func (*Request) GetPath ¶

func (request *Request) GetPath() string

GetPath 方法用于获取 HTTP 请求的 Path 部分的字符串。

func (*Request) GetProto ¶

func (request *Request) GetProto() string

GetProto 方法用于获取 HTTP 请求的 Proto 部分的字符串。

func (*Request) GetQueryParams ¶

func (request *Request) GetQueryParams() url.Values

GetQueryParams 方法用于获取 HTTP 请求的 Query 部分的 url.Values。

func (*Request) GetQueryParamsEncode ¶

func (request *Request) GetQueryParamsEncode() string

GetQueryParamsEncode 方法用于获取 HTTP 请求的 Query 部分的 URL 编码字符串。

func (*Request) GetQueryParamsNopCloser ¶

func (request *Request) GetQueryParamsNopCloser() io.ReadCloser

GetQueryParamsNopCloser 方法用于获取 HTTP 请求的 Query 部分的 ReadCloser。

func (*Request) GetRequestHeader ¶

func (request *Request) GetRequestHeader() http.Header

GetRequestHeader 方法用于获取 HTTP 请求的 Header 部分的 http.Header。

func (*Request) GetUrl ¶

func (request *Request) GetUrl() string

GetUrl 方法用于获取 HTTP 请求的 URL 部分的字符串。

func (*Request) Head ¶

func (request *Request) Head(url string) (*Response, error)

Head 方法用于创建一个 HEAD 请求。它接收一个 string 类型的参数，表示 HTTP 请求的路径。

func (*Request) Options ¶

func (request *Request) Options(url string) (*Response, error)

Options 方法用于创建一个 OPTIONS 请求。它接收一个 string 类型的参数，表示 HTTP 请求的路径。

func (*Request) Patch ¶

func (request *Request) Patch(url string) (*Response, error)

Patch 方法用于创建一个 PATCH 请求。它接收一个 string 类型的参数，表示 HTTP 请求的路径。

func (*Request) Post ¶

func (request *Request) Post(url string) (*Response, error)

Post 方法用于创建一个 POST 请求。它接收一个 string 类型的参数，表示 HTTP 请求的路径。

func (*Request) Put ¶

func (request *Request) Put(url string) (*Response, error)

Put 方法用于创建一个 PUT 请求。它接收一个 string 类型的参数，表示 HTTP 请求的路径。

func (*Request) SetBody ¶

func (request *Request) SetBody(body interface{}) *Request

SetBody 方法用于设置 HTTP 请求的 Body 部分。它接收一个 interface{} 类型的参数，该参数可以是以下几种类型：string, []byte, map[string]interface{}, map[string]string, map[string]int, map[string]int64, map[string]float64, map[string]float32, map[string]bool。对于不支持的类型，方法会设置 ContentLength 为 -1，并将 GetBody 方法设置为返回 nil。如果成功设置了 body，方法会返回 Request 指针本身，以便进行链式调用。

func (*Request) SetContentType ¶

func (request *Request) SetContentType(contentType string) *Request

SetContentType 方法用于设置 HTTP 请求的 Content-Type 部分。它接收一个 string 类型的参数，

func (*Request) SetCookie ¶

func (request *Request) SetCookie(cookie *http.Cookie) *Request

SetCookie 方法用于设置 HTTP 请求的 Cookie 部分。它接收一个 *http.Cookie 类型的参数，

func (*Request) SetCookies ¶

func (request *Request) SetCookies(cookie []*http.Cookie) *Request

SetCookies 方法用于设置 HTTP 请求的 Cookies 部分。它接收一个 []*http.Cookie 类型的参数，

func (*Request) SetHeader ¶

func (request *Request) SetHeader(key, value string) *Request