-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
crochee
committed
Nov 28, 2023
1 parent
f79298e
commit 16a8289
Showing
14 changed files
with
1,068 additions
and
3 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -13,3 +13,5 @@ | |
|
||
# Dependency directories (remove the comment below to include it) | ||
# vendor/ | ||
*vscode | ||
.idea |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,2 +1,127 @@ | ||
# reqest | ||
magic Go HTTP client,like k8s client-go | ||
# rest | ||
restful api Go HTTP client,like k8s client-go | ||
# Get Started | ||
## install | ||
You first need Go installed (version 1.17+ is required), then you can use the below Go command to install req: | ||
```go | ||
go get -u github.com/crochee/rest | ||
``` | ||
## Usage | ||
### Basic | ||
```go | ||
package main | ||
|
||
import ( | ||
"context" | ||
"log" | ||
"net/http" | ||
|
||
"github.com/crochee/rest" | ||
) | ||
|
||
type Opts struct { | ||
Offset int `form:"offset"` | ||
Limit int `form:"limit"` | ||
} | ||
|
||
func main() { | ||
var result struct { | ||
Content string `json:"content"` | ||
} | ||
if err := rest.Get(). | ||
Endpoint("http://localhost:80"). | ||
Prefix("v2"). | ||
Resource("books"). | ||
Query("limit", "20"). | ||
Do(context.Background(), &result); err != nil { | ||
log.Println(err) | ||
} | ||
// curl 'http://localhost:80/v2/books?limit=20' | ||
|
||
if err := rest.Get(). | ||
Endpoint("http://localhost:80"). | ||
Prefix("v2"). | ||
Resource("books"). | ||
Querys(Opts{Offset: 0, Limit: 20}). | ||
Do(context.Background(), &result); err != nil { | ||
log.Println(err) | ||
} | ||
// curl 'http://localhost:80/v2/books?limit=20' | ||
|
||
if err := rest.Post(). | ||
Endpoint("http://localhost:80"). | ||
Prefix("v2"). | ||
Resource("books"). | ||
Body(map[string]interface{}{"name": "test"}]). | ||
Do(context.Background(), &result); err != nil { | ||
log.Println(err) | ||
} | ||
// curl -X POST 'http://localhost:80/v2/books' -d '{"name": "test"}' | ||
} | ||
``` | ||
### Multiple | ||
client.go | ||
```go | ||
package main | ||
|
||
import ( | ||
"context" | ||
"log" | ||
"net/http" | ||
|
||
"github.com/crochee/rest" | ||
) | ||
|
||
type IClient interface { | ||
Area() AreaSrv | ||
} | ||
|
||
func NewGateway() IClient { | ||
return &baseClient{reqest.NewHandler().Endpoint("http://localhost:80")} | ||
} | ||
|
||
type baseClient struct { | ||
rest.Handler | ||
} | ||
|
||
func (c baseClient) Area() AreaSrv { | ||
return areaSrv{c.Resource("areas")} | ||
} | ||
|
||
type AreaSrv interface { | ||
Get(ctx context.Context, id string) (*Areas, error) | ||
} | ||
|
||
type areaSrv struct { | ||
rest.Handler | ||
} | ||
|
||
func (a areaSrv) Get(ctx context.Context, id string) (*Areas, error) { | ||
var result Areas | ||
if err := a.To(). | ||
Get(). | ||
Prefix("v2"). | ||
Name(id). | ||
Do(ctx, &result); err != nil { | ||
return nil, err | ||
} | ||
return &result, nil | ||
} | ||
|
||
type Areas struct { | ||
List []string `json:"list"` | ||
PageNum int `json:"page_num"` | ||
PageSize int `json:"page_size"` | ||
Total int `json:"total"` | ||
} | ||
|
||
func main() { | ||
result, err := NewGateway().Area().Get(context.Background(), "12") | ||
if err != nil { | ||
log.Fatal(err) | ||
} | ||
log.Println(result) | ||
} | ||
``` | ||
# Contributing | ||
If you have a bug report or feature request, you can [open an issue](https://github.com/crochee/rest/issues/new) or [pull request](https://github.com/crochee/rest/pulls). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,26 @@ | ||
package rest | ||
|
||
import ( | ||
"encoding/json" | ||
"fmt" | ||
"net/http" | ||
) | ||
|
||
func ErrorFunc(expectStatusCode int) func(*http.Response) error { | ||
return func(resp *http.Response) error { | ||
if resp.StatusCode != expectStatusCode { | ||
decoder := json.NewDecoder(resp.Body) | ||
decoder.UseNumber() | ||
var result struct { | ||
Code string `json:"code"` | ||
Message string `json:"message"` | ||
Result interface{} `json:"result"` | ||
} | ||
if err := decoder.Decode(&result); err != nil { | ||
return err | ||
} | ||
return fmt.Errorf("code:%s, message:%s, result:%v", result.Code, result.Message, result.Result) | ||
} | ||
return nil | ||
} | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,12 @@ | ||
module github.com/crochee/rest | ||
|
||
go 1.17 | ||
|
||
require ( | ||
github.com/cenkalti/backoff/v4 v4.1.3 | ||
github.com/golang/mock v1.6.0 | ||
github.com/gorilla/schema v1.2.0 | ||
go.uber.org/multierr v1.8.0 | ||
) | ||
|
||
require go.uber.org/atomic v1.10.0 // indirect |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,47 @@ | ||
github.com/cenkalti/backoff/v4 v4.1.3 h1:cFAlzYUlVYDysBEH2T5hyJZMh3+5+WCBvSnK6Q8UtC4= | ||
github.com/cenkalti/backoff/v4 v4.1.3/go.mod h1:scbssz8iZGpm3xbr14ovlUdkxfGXNInqkPWOWmG2CLw= | ||
github.com/davecgh/go-spew v1.1.0/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= | ||
github.com/davecgh/go-spew v1.1.1 h1:vj9j/u1bqnvCEfJOwUhtlOARqs3+rkHYY13jYWTU97c= | ||
github.com/davecgh/go-spew v1.1.1/go.mod h1:J7Y8YcW2NihsgmVo/mv3lAwl/skON4iLHjSsI+c5H38= | ||
github.com/golang/mock v1.6.0 h1:ErTB+efbowRARo13NNdxyJji2egdxLGQhRaY+DUumQc= | ||
github.com/golang/mock v1.6.0/go.mod h1:p6yTPP+5HYm5mzsMV8JkE6ZKdX+/wYM6Hr+LicevLPs= | ||
github.com/gorilla/schema v1.2.0 h1:YufUaxZYCKGFuAq3c96BOhjgd5nmXiOY9NGzF247Tsc= | ||
github.com/gorilla/schema v1.2.0/go.mod h1:kgLaKoK1FELgZqMAVxx/5cbj0kT+57qxUrAlIO2eleU= | ||
github.com/pmezard/go-difflib v1.0.0 h1:4DBwDE0NGyQoBHbLQYPwSUPoCMWR5BEzIk/f1lZbAQM= | ||
github.com/pmezard/go-difflib v1.0.0/go.mod h1:iKH77koFhYxTK1pcRnkKkqfTogsbg7gZNVY4sRDYZ/4= | ||
github.com/stretchr/objx v0.1.0/go.mod h1:HFkY916IF+rwdDfMAkV7OtwuqBVzrE8GR6GFx+wExME= | ||
github.com/stretchr/testify v1.3.0/go.mod h1:M5WIy9Dh21IEIfnGCwXGc5bZfKNJtfHm1UVUgZn+9EI= | ||
github.com/stretchr/testify v1.7.0 h1:nwc3DEeHmmLAfoZucVR881uASk0Mfjw8xYJ99tb5CcY= | ||
github.com/stretchr/testify v1.7.0/go.mod h1:6Fq8oRcR53rry900zMqJjRRixrwX3KX962/h/Wwjteg= | ||
github.com/yuin/goldmark v1.3.5/go.mod h1:mwnBkeHKe2W/ZEtQ+71ViKU8L12m81fl3OWwC1Zlc8k= | ||
go.uber.org/atomic v1.7.0/go.mod h1:fEN4uk6kAWBTFdckzkM89CLk9XfWZrxpCo0nPH17wJc= | ||
go.uber.org/atomic v1.10.0 h1:9qC72Qh0+3MqyJbAn8YU5xVq1frD8bn3JtD2oXtafVQ= | ||
go.uber.org/atomic v1.10.0/go.mod h1:LUxbIzbOniOlMKjJjyPfpl4v+PKK2cNJn91OQbhoJI0= | ||
go.uber.org/multierr v1.8.0 h1:dg6GjLku4EH+249NNmoIciG9N/jURbDG+pFlTkhzIC8= | ||
go.uber.org/multierr v1.8.0/go.mod h1:7EAYxJLBy9rStEaz58O2t4Uvip6FSURkq8/ppBp95ak= | ||
golang.org/x/crypto v0.0.0-20190308221718-c2843e01d9a2/go.mod h1:djNgcEr1/C05ACkg1iLfiJU5Ep61QUkGW8qpdssI0+w= | ||
golang.org/x/crypto v0.0.0-20191011191535-87dc89f01550/go.mod h1:yigFU9vqHzYiE8UmvKecakEJjdnWj3jj499lnFckfCI= | ||
golang.org/x/mod v0.4.2/go.mod h1:s0Qsj1ACt9ePp/hMypM3fl4fZqREWJwdYDEqhRiZZUA= | ||
golang.org/x/net v0.0.0-20190404232315-eb5bcb51f2a3/go.mod h1:t9HGtf8HONx5eT2rtn7q6eTqICYqUVnKs3thJo3Qplg= | ||
golang.org/x/net v0.0.0-20190620200207-3b0461eec859/go.mod h1:z5CRVTTTmAJ677TzLLGU+0bjPO0LkuOLi4/5GtJWs/s= | ||
golang.org/x/net v0.0.0-20210405180319-a5a99cb37ef4/go.mod h1:p54w0d4576C0XHj96bSt6lcn1PtDYWL6XObtHCRCNQM= | ||
golang.org/x/sync v0.0.0-20190423024810-112230192c58/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= | ||
golang.org/x/sync v0.0.0-20210220032951-036812b2e83c/go.mod h1:RxMgew5VJxzue5/jJTE5uejpjVlOe/izrB70Jof72aM= | ||
golang.org/x/sys v0.0.0-20190215142949-d0b11bdaac8a/go.mod h1:STP8DvDyc/dI5b8T5hshtkjS+E42TnysNCUPdjciGhY= | ||
golang.org/x/sys v0.0.0-20190412213103-97732733099d/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= | ||
golang.org/x/sys v0.0.0-20201119102817-f84b799fce68/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= | ||
golang.org/x/sys v0.0.0-20210330210617-4fbd30eecc44/go.mod h1:h1NjWce9XRLGQEsW7wpKNCjG9DtNlClVuFLEZdDNbEs= | ||
golang.org/x/sys v0.0.0-20210510120138-977fb7262007/go.mod h1:oPkhp1MJrh7nUepCBck5+mAzfO9JrbApNNgaTdGDITg= | ||
golang.org/x/term v0.0.0-20201126162022-7de9c90e9dd1/go.mod h1:bj7SfCRtBDWHUb9snDiAeCFNEtKQo2Wmx5Cou7ajbmo= | ||
golang.org/x/text v0.3.0/go.mod h1:NqM8EUOU14njkJ3fqMW+pc6Ldnwhi/IjpwHt7yyuwOQ= | ||
golang.org/x/text v0.3.3/go.mod h1:5Zoc/QRtKVWzQhOtBMvqHzDpF6irO9z98xDceosuGiQ= | ||
golang.org/x/tools v0.0.0-20180917221912-90fa682c2a6e/go.mod h1:n7NCudcB/nEzxVGmLbDWY5pfWTLqBcC2KZ6jyYvM4mQ= | ||
golang.org/x/tools v0.0.0-20191119224855-298f0cb1881e/go.mod h1:b+2E5dAYhXwXZwtnZ6UAqBI28+e2cm9otk0dWdXHAEo= | ||
golang.org/x/tools v0.1.1/go.mod h1:o0xws9oXOQQZyjljx8fwUC0k7L1pTE6eaCbjGeHmOkk= | ||
golang.org/x/xerrors v0.0.0-20190717185122-a985d3407aa7/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= | ||
golang.org/x/xerrors v0.0.0-20191011141410-1b5146add898/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= | ||
golang.org/x/xerrors v0.0.0-20200804184101-5ec99f83aff1/go.mod h1:I/5z698sn9Ka8TeJc9MKroUUfqBBauWjQqLJ2OPfmY0= | ||
gopkg.in/check.v1 v0.0.0-20161208181325-20d25e280405/go.mod h1:Co6ibVJAznAaIkqp8huTwlJQCZ016jof/cbN4VW5Yz0= | ||
gopkg.in/yaml.v3 v3.0.0-20200313102051-9f266ea9e77c/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= | ||
gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b h1:h8qDotaEPuJATrMmW04NCwg7v22aHH28wwpauUhK9Oo= | ||
gopkg.in/yaml.v3 v3.0.0-20210107192922-496545a6307b/go.mod h1:K4uyk7z7BCEPqu6E+C64Yfv1cQ7kz7rIZviUmN+EgEM= |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,28 @@ | ||
package rest | ||
|
||
import "context" | ||
|
||
type Logger interface { | ||
Debugf(format string, v ...interface{}) | ||
Infof(format string, v ...interface{}) | ||
Warnf(format string, v ...interface{}) | ||
Errorf(format string, v ...interface{}) | ||
} | ||
|
||
func Nop(context.Context) Logger { | ||
return nop{} | ||
} | ||
|
||
type nop struct{} | ||
|
||
func (no nop) Debugf(format string, v ...interface{}) { | ||
} | ||
|
||
func (no nop) Infof(format string, v ...interface{}) { | ||
} | ||
|
||
func (no nop) Warnf(format string, v ...interface{}) { | ||
} | ||
|
||
func (no nop) Errorf(format string, v ...interface{}) { | ||
} |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,56 @@ | ||
package rest | ||
|
||
import ( | ||
"bytes" | ||
"context" | ||
"encoding/json" | ||
"io" | ||
"net/http" | ||
"strings" | ||
) | ||
|
||
type Requester interface { | ||
Build(ctx context.Context, method, url string, body interface{}, headers http.Header) (*http.Request, error) | ||
} | ||
|
||
type JsonRequest struct { | ||
} | ||
|
||
func (j JsonRequest) Build(ctx context.Context, method string, url string, body interface{}, headers http.Header) (*http.Request, error) { | ||
var ( | ||
reader io.Reader | ||
objectData bool | ||
) | ||
if body != nil { | ||
switch data := body.(type) { | ||
case string: | ||
reader = strings.NewReader(data) | ||
case []byte: | ||
reader = bytes.NewReader(data) | ||
case io.Reader: | ||
reader = data | ||
default: | ||
content, err := json.Marshal(data) | ||
if err != nil { | ||
return nil, err | ||
} | ||
objectData = true | ||
reader = bytes.NewReader(content) | ||
} | ||
} | ||
req, err := http.NewRequestWithContext(ctx, method, url, reader) | ||
if err != nil { | ||
return nil, err | ||
} | ||
for key, values := range headers { | ||
for _, value := range values { | ||
req.Header.Add(key, value) | ||
} | ||
} | ||
|
||
if objectData { | ||
req.Header.Set("Content-Type", "application/json; charset=utf-8") | ||
} | ||
|
||
return req, nil | ||
} |
Oops, something went wrong.