Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/izumin5210/hx
🌏 Developer-friendly, Real-World-ready and extensible HTTP client for Go
https://github.com/izumin5210/hx
go golang http http-client
Last synced: 29 days ago
JSON representation
🌏 Developer-friendly, Real-World-ready and extensible HTTP client for Go
- Host: GitHub
- URL: https://github.com/izumin5210/hx
- Owner: izumin5210
- License: mit
- Created: 2019-11-03T13:29:03.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2019-12-01T23:17:49.000Z (almost 5 years ago)
- Last Synced: 2024-05-21T11:11:53.408Z (6 months ago)
- Topics: go, golang, http, http-client
- Language: Go
- Homepage: https://godoc.org/github.com/izumin5210/hx
- Size: 118 KB
- Stars: 12
- Watchers: 3
- Forks: 2
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# hx
[](https://github.com/izumin5210/hx/actions?workflow=CI)
[](https://godoc.org/github.com/izumin5210/hx)
[](https://codecov.io/gh/izumin5210/hx)
[](./LICENSE)
Developer-friendly, Production-ready and extensible HTTP client for Go
## Features
...
### Plugins
- [hxlog](./plugins/hxlog) - Logging requests and responses with standard logger
- [hxlog](./plugins/hxzap) - Logging requests and responses with [zap](https://github.com/uber-go/zap)
- [pb](./plugins/pb) - Marshaling and Unmarshaling protocol buffers
- [retry](./plugins/retry) - Retrying HTTP requests
## Examples
### Simple GET
```go
type Content struct {
Body string `json:"body"`
}
var cont Content
ctx := context.Background()
err := hx.Get(ctx, "https://api.example.com/contents/1",
hx.WhenSuccess(hx.AsJSON(&cont)),
hx.WhenFailure(hx.AsError()),
)
```
### Real-world
```go
func init() {
defaultTransport := hxutil.CloneTransport(http.DefaultTransport.(*http.Transport))
// Tweak keep-alive configuration
defaultTransport.MaxIdleConns = 500
defaultTransport.MaxIdleConnsPerHost = 100
// Set global options
hx.DefaultOptions = append(
hx.DefaultOptions,
hx.UserAgent(fmt.Sprintf("yourapp (%s)", hx.DefaultUserAgent)),
hx.Transport(defaultTransport),
hx.TransportFrom(func(rt http.RoundTripper) http.RoundTripper {
return &ochttp.Transport{Base: rt}
}),
)
}
func NewContentAPI() *hx.Client {
// Set common options for API ciient
return &ContentAPI{
client: hx.NewClient(
hx.BaseURL("https://api.example.com"),
),
}
}
type ContentAPI struct {
client *hx.Client
}
func (a *ContentAPI) GetContent(ctx context.Context, id int) (*Content, error) {
var cont Content
err := a.client.Get(ctx, hx.Path("api", "contents", id),
hx.WhenSuccess(hx.AsJSON(&cont)),
hx.WhenFailure(hx.AsError()),
)
if err != nil {
// ...
}
return &cont, nil
}
func (a *ContentAPI) CreateContent(ctx context.Context, in *Content) (*Content, error) {
var out Content
err := a.client.Post(ctx, "/api/contents",
hx.JSON(in),
hx.WhenSuccess(hx.AsJSON(&out)),
hx.WhenStatus(hx.AsJSONError(&InvalidArgument{}), http.StatusBadRequest),
hx.WhenFailure(hx.AsError()),
)
if err != nil {
var (
invalidArgErr *InvalidArgument
respErr *hx.ResponseError
)
if errors.As(err, &invalidArgErr) {
// handle known error
} else if errors.As(err, &respErr) {
// handle unknown response error
} else {
err := errors.Unwrap(err)
// handle unknown error
}
}
return &out, nil
}
```