Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gookit/greq
π greq is a simple http client request builder and sender.
https://github.com/gookit/greq
golang http http-client middleware request
Last synced: 3 months ago
JSON representation
π greq is a simple http client request builder and sender.
- Host: GitHub
- URL: https://github.com/gookit/greq
- Owner: gookit
- License: mit
- Created: 2022-01-10T05:29:01.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-11-09T02:41:25.000Z (3 months ago)
- Last Synced: 2024-11-09T03:28:07.513Z (3 months ago)
- Topics: golang, http, http-client, middleware, request
- Language: Go
- Homepage:
- Size: 126 KB
- Stars: 7
- Watchers: 3
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Greq
[](https://github.com/gookit/goutil)
[](https://pkg.go.dev/github.com/gookit/greq)
[](https://goreportcard.com/report/github.com/gookit/greq)
[](https://github.com/gookit/greq/actions)
[](https://coveralls.io/github/gookit/greq?branch=main)
> [δΈζθ―΄ζ](README.zh-CN.md) | [English](README.md)
**greq** A simple http client request builder and sender
## Features
- Make http requests, supports `GET,POST,PUT,PATCH,DELETE,HEAD`
- Transform request and response data
- Supports chain configuration request
- Supports defining and adding middleware
- Supports defining request body provider and response decoder
- Built-In: fom, json request body provider
- Built-In: xml, json response body decoder
## Install
```bash
go get github.com/gookit/greq
```
## Quick start
```go
package main
import (
"github.com/gookit/goutil/dump"
"github.com/gookit/greq"
)
func main() {
resp, err := greq.New("https://httpbin.org").
JSONType().
UserAgent("custom-client/1.0").
PostDo("/post", `{"name": "inhere"}`)
if err != nil {
panic(err)
}
ret := make(map[string]any)
err = resp.Decode(&ret)
if err != nil {
panic(err)
}
dump.P(ret)
}
```
Result:
```text
PRINT AT github.com/gookit/greq_test.TestHReq_Send(greq_test.go:73)
map[string]interface {} { #len=4
"args": map[string]interface {} { #len=0
},
"headers": map[string]interface {} { #len=4
"Host": string("httpbin.org"), #len=11
"User-Agent": string("custom-client/1.0"), #len=17
"X-Amzn-Trace-Id": string("Root=1-61e4d41e-06e27ae12ff872a224373ca7"), #len=40
"Accept-Encoding": string("gzip"), #len=4
},
"origin": string("222.210.59.218"), #len=14
"url": string("https://httpbin.org/post"), #len=24
},
```
## Request headers
```go
greq.New("some.host/api").
SetHeader("req-id", "a string")
```
Set multi at once:
```go
greq.New("some.host/api").
SetHeaders(map[string]string{
"req-id": "a string",
})
```
### Set content type
```go
greq.New("some.host/api").
ContentType("text/html")
```
Built in `JSONType()` `FromType()` `XMLType()`
```go
greq.New("some.host/api").JSONType()
```
## Use middleware
```go
buf := &bytes.Buffer{}
mid0 := greq.MiddleFunc(func(r *http.Request, next greq.HandleFunc) (*greq.Response, error) {
buf.WriteString("MID0>>")
w, err := next(r)
buf.WriteString(">>MID0")
return w, err
})
mid1 := greq.MiddleFunc(func(r *http.Request, next greq.HandleFunc) (*greq.Response, error) {
buf.WriteString("MID1>>")
w, err := next(r)
buf.WriteString(">>MID1")
return w, err
})
mid2 := greq.MiddleFunc(func(r *http.Request, next greq.HandleFunc) (*greq.Response, error) {
buf.WriteString("MID2>>")
w, err := next(r)
buf.WriteString(">>MID2")
return w, err
})
resp, err := greq.New("https://httpbin.org").
Doer(httpreq.DoerFunc(func(req *http.Request) (*http.Response, error) {
tw := httptest.NewRecorder()
buf.WriteString("(CORE)")
return tw.Result(), nil
})).
Middleware(mid0, mid1, mid2).
GetDo("/get")
fmt.Println(buf.String())
```
**Output**:
```text
MID2>>MID1>>MID0>>(CORE)>>MID0>>MID1>>MID2
```
## More usage
### Check response
- `Response.IsOK() bool`
- `Response.IsFail() bool`
- `Response.IsEmptyBody() bool`
- `Response.IsJSONType() bool`
- `Response.IsContentType(prefix string) bool`
### Get response data
- `Response.ContentType() string`
- `Response.Decode(ptr any) error`
### Request to string
```go
str := greq.New("https://httpbin.org").
UserAgent("some-client/1.0").
BasicAuth("inhere", "some string").
JSONType().
Body("hi, with body").
Post("/post").
String()
fmt.Println(str)
```
**Output**:
```text
POST https://httpbin.org/post/ HTTP/1.1
User-Agent: some-client/1.0
Authorization: Basic aW5oZXJlOnNvbWUgc3RyaW5n
Content-Type: application/json; charset=utf-8
hi, with body
```
### Response to string
`greq.Response.String()` can convert response to string.
```go
package main
import (
"fmt"
"github.com/gookit/goutil/dump"
"github.com/gookit/greq"
)
func main() {
resp, err := greq.New("https://httpbin.org").
UserAgent("custom-client/1.0").
Send("/get")
if err != nil {
panic(err)
}
fmt.Print(resp.String())
}
```
**Output**:
```text
HTTP/2.0 200 OK
Access-Control-Allow-Origin: *
Access-Control-Allow-Credentials: true
Date: Tue, 18 Jan 2022 04:52:39 GMT
Content-Type: application/json
Content-Length: 272
Server: gunicorn/19.9.0
{
"args": {},
"headers": {
"Accept-Encoding": "gzip",
"Host": "httpbin.org",
"User-Agent": "custom-client/1.0",
"X-Amzn-Trace-Id": "Root=1-61e64797-3e428a925f7709906a8b7c01"
},
"origin": "222.210.59.218",
"url": "https://httpbin.org/get"
}
```
## Refers
- https://github.com/dghubble/sling
- https://github.com/zhshch2002/goreq
- https://github.com/go-resty/resty
- https://github.com/monaco-io/request
[1]: https://github.com/dghubble/sling