Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/go-zoox/fetch
Go Fetch - A Powerful, Lightweight, Easy Http Client, inspired by Web Fetch API
https://github.com/go-zoox/fetch
Last synced: about 2 months ago
JSON representation
Go Fetch - A Powerful, Lightweight, Easy Http Client, inspired by Web Fetch API
- Host: GitHub
- URL: https://github.com/go-zoox/fetch
- Owner: go-zoox
- License: mit
- Created: 2022-03-15T17:55:35.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-07-26T09:35:50.000Z (5 months ago)
- Last Synced: 2024-07-31T20:52:47.554Z (4 months ago)
- Language: Go
- Homepage:
- Size: 115 KB
- Stars: 72
- Watchers: 3
- Forks: 5
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - go-zoox/fetch - A Powerful, Lightweight, Easy Http Client, inspired by Web Fetch API. (Networking / HTTP Clients)
- zero-alloc-awesome-go - go-zoox/fetch - A Powerful, Lightweight, Easy Http Client, inspired by Web Fetch API. (Networking / HTTP Clients)
- awesome-go-extra - fetch - A Powerful, Lightweight, Easy Http Client, inspired by Web Fetch API|3|1|1|2022-03-15T17:55:35Z|2022-08-24T06:03:54Z| (Networking / HTTP Clients)
README
# Fetch - HTTP Client
`HTTP Client` for Go, inspired by the [Fetch API](https://developer.mozilla.org/en-US/docs/Web/API/Fetch_API), and [Axios](https://github.com/axios/axios) + [Got](https://github.com/sindresorhus/got) (Sindre Sorhus).
[](https://pkg.go.dev/github.com/go-zoox/fetch)
[](https://github.com/go-zoox/fetch/actions/workflows/ci.yml)
[](https://goreportcard.com/report/github.com/go-zoox/fetch)
[](https://coveralls.io/github/go-zoox/fetch?branch=master)
[](https://github.com/go-zoox/fetch/issues)
[](https://github.com/go-zoox/fetch/releases)
## Features
### Main API
- [x] Make HTTP requests
- [x] Easy JSON Response
- [ ] GZip support
- [x] Decode GZip response
- [ ] Encode GZip request (Upload File with GZip)
- [x] HTTP/2 support
- [x] TLS
- [x] Custom TLS Ca Certificate (Self signed certificate) [Example](https://github.com/go-zoox/examples/tree/master/https/fetch)
- [x] Custom Client Cert and Key for two-way authentication (Client Cert and Key)
- [x] Simple Auth Methods
- [x] Basic Auth
- [x] Bearer Auth
- [x] Support cancel (using context)
### Timeouts and retries
- [x] Support timeout
- [x] Support retry on failure
### Progress
- [x] Support progress and progress events
### File upload and download
- [x] Download files easily
- [x] Upload files easily
### Cache, Proxy and UNIX sockets
- [ ] [RFC compliant caching](https://github.com/sindresorhus/got/blob/main/documentation/cache.md)
- [x] Proxy support
- [x] Environment variables (HTTP_PROXY/HTTPS_PROXY/SOCKS_PROXY)
- [x] Custom proxy
- [x] UNIX Domain Sockets
- [Example: HTTP](https://github.com/go-zoox/examples/tree/master/unix-domain-socket/http)
- [Example: HTTPs](https://github.com/go-zoox/examples/tree/master/unix-domain-socket/https)
### WebDAV
- [ ] WebDAV protocol support
### Advanced creation
- [ ] Plugin system
- [ ] Middleware system
## Installation
To install the package, run:
```bash
go get github.com/go-zoox/fetch
```
## Methods
- [x] GET
- [x] POST
- [x] PUT
- [x] PATCH
- [x] DELETE
- [x] HEAD
- [ ] OPTIONS
- [ ] TRACE
- [ ] CONNECT
## Getting Started
```go
package main
import (
"github.com/go-zoox/fetch"
)
func main() {
response, _ := fetch.Get("https://httpbin.zcorky.com/get")
url := response.Get("url")
method := response.Get("method")
fmt.Println(url, method)
}
```
## Examples
### Get
```go
package main
import (
"github.com/go-zoox/fetch"
)
func main() {
response, err := fetch.Get("https://httpbin.zcorky.com/get")
if err != nil {
panic(err)
}
fmt.Println(response.JSON())
}
```
### Post
```go
package main
import (
"github.com/go-zoox/fetch"
)
func main() {
response, err := fetch.Post("https://httpbin.zcorky.com/post", &fetch.Config{
Body: map[string]interface{}{
"foo": "bar",
"foo2": "bar2",
"number": 1,
"boolean": true,
"array": []string{
"foo3",
"bar3",
},
"nest": map[string]string{
"foo4": "bar4",
},
},
})
if err != nil {
panic(err)
}
fmt.Println(response.JSON())
}
```
### Put
```go
package main
import (
"github.com/go-zoox/fetch"
)
func main() {
response, err := fetch.Put("https://httpbin.zcorky.com/put", &fetch.Config{
Body: map[string]interface{}{
"foo": "bar",
"foo2": "bar2",
"number": 1,
"boolean": true,
"array": []string{
"foo3",
"bar3",
},
"nest": map[string]string{
"foo4": "bar4",
},
},
})
if err != nil {
panic(err)
}
fmt.Println(response.JSON())
}
```
### Delete
```go
package main
import (
"github.com/go-zoox/fetch"
)
func main() {
response, err := fetch.Delete("https://httpbin.zcorky.com/Delete", &fetch.Config{
Body: map[string]interface{}{
"foo": "bar",
"foo2": "bar2",
"number": 1,
"boolean": true,
"array": []string{
"foo3",
"bar3",
},
"nest": map[string]string{
"foo4": "bar4",
},
},
})
if err != nil {
panic(err)
}
fmt.Println(response.JSON())
}
```
### Timeout
```go
package main
import (
"github.com/go-zoox/fetch"
)
func main() {
response, err := fetch.Get("https://httpbin.zcorky.com/get", &fetch.Config{
Timeout: 5 * time.Second,
})
if err != nil {
panic(err)
}
fmt.Println(response.JSON())
}
```
### Proxy
```go
package main
import (
"github.com/go-zoox/fetch"
)
func main() {
response, err := fetch.Get("https://httpbin.zcorky.com/ip", &fetch.Config{
Proxy: "http://127.0.0.1:17890",
})
if err != nil {
panic(err)
}
fmt.Println(response.JSON())
}
```
### Basic Auth
```go
package main
import (
"github.com/go-zoox/fetch"
)
func main() {
response, err := fetch.Get("https://httpbin.zcorky.com/ip", &fetch.Config{
BasicAuth: &fetch.BasicAuth{
Username: "foo",
Password: "bar",
},
})
if err != nil {
panic(err)
}
fmt.Println(response.JSON())
}
```
### Download
```go
package main
import (
"github.com/go-zoox/fetch"
)
func main() {
response, err := fetch.Download("https://httpbin.zcorky.com/image", "/tmp/image.webp")
if err != nil {
panic(err)
}
}
```
### Upload
```go
package main
import (
"github.com/go-zoox/fetch"
)
func main() {
file, _ := os.Open("go.mod")
response, err := Upload("https://httpbin.zcorky.com/upload", file)
if err != nil {
panic(err)
}
fmt.Println(response.JSON())
}
```
### Cancel
```go
package main
import (
"github.com/go-zoox/fetch"
)
func main() {
file, _ := os.Open("go.mod")
ctx, cancel := context.WithCancel(context.Background())
f := fetch.New()
f.SetBaseURL("https://httpbin.zcorky.com")
f.SetURL("/delay/3")
f.SetContext(ctx)
go func() {
_, err := f.Execute()
fmt.Println(err)
}()
cancel()
}
```
## Depencencies
- [gjson](github.com/tidwall/gjson) - Get JSON Whenever You Need, you don't
define type firstγ
## Inspired By
- [sindresorhus/got](https://github.com/sindresorhus/got) - π Human-friendly and powerful HTTP request library for Node.js
- [axios/axios](https://github.com/axios/axios) - Promise based HTTP client for the browser and node.js
- [mozillazg/request](https://github.com/mozillazg/request) - A
developer-friendly HTTP request library for Gopher
- [monaco-io/request](https://github.com/monaco-io/request) - go request, go http client
## License
GoZoox is released under the [MIT License](./LICENSE).