Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ggicci/httpin
🍡 HTTP Input for Go - HTTP Request from/to Go Struct (Bi-directional Data Binding between Go Struct and http.Request)
https://github.com/ggicci/httpin
data-binding go go-api go-http go-http-middleware go-http-requests go-rest-api http-request-params-reader
Last synced: about 2 months ago
JSON representation
🍡 HTTP Input for Go - HTTP Request from/to Go Struct (Bi-directional Data Binding between Go Struct and http.Request)
- Host: GitHub
- URL: https://github.com/ggicci/httpin
- Owner: ggicci
- License: mit
- Created: 2021-04-13T02:15:36.000Z (over 3 years ago)
- Default Branch: main
- Last Pushed: 2024-05-20T22:56:33.000Z (7 months ago)
- Last Synced: 2024-07-31T20:51:40.639Z (5 months ago)
- Topics: data-binding, go, go-api, go-http, go-http-middleware, go-http-requests, go-rest-api, http-request-params-reader
- Language: Go
- Homepage: https://ggicci.github.io/httpin/
- Size: 1.5 MB
- Stars: 294
- Watchers: 3
- Forks: 21
- Open Issues: 9
-
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- awesome-go - httpin - Decode an HTTP request into a custom struct, including querystring, forms, HTTP headers, etc. (Forms / Search and Analytic Databases)
- awesome-go-extra - httpin - Decode an HTTP request into a custom struct|103|10|5|2021-04-13T02:15:36Z|2022-08-07T16:11:30Z| (Forms / Advanced Console UIs)
README
# httpin - HTTP Input for Go
HTTP Request from/to Go Struct
[](https://github.com/ggicci/httpin/actions/workflows/go.yml) [](https://github.com/ggicci/httpin/actions/workflows/documentation.yml) [](https://codecov.io/gh/ggicci/httpin) [](https://goreportcard.com/report/github.com/ggicci/httpin) [](https://github.com/avelino/awesome-go) [](https://pkg.go.dev/github.com/ggicci/httpin)
## Core Features
**httpin** helps you easily decode data from an HTTP request, including:
- **Query parameters**, e.g. `?name=john&is_member=true`
- **Headers**, e.g. `Authorization: xxx`
- **Form data**, e.g. `username=john&password=******`
- **JSON/XML Body**, e.g. `POST {"name":"john"}`
- **Path variables**, e.g. `/users/{username}`
- **File uploads**
You **only** need to define a struct to receive/bind data from an HTTP request, **without** writing any parsing stuff code by yourself.
Since v0.15.0, httpin also supports creating an HTTP request (`http.Request`) from a Go struct instance.
**httpin** is:
- **well documented**: at https://ggicci.github.io/httpin/
- **open integrated**: with [net/http](https://ggicci.github.io/httpin/integrations/http), [go-chi/chi](https://ggicci.github.io/httpin/integrations/gochi), [gorilla/mux](https://ggicci.github.io/httpin/integrations/gorilla), [gin-gonic/gin](https://ggicci.github.io/httpin/integrations/gin), etc.
- **extensible** (advanced feature): by adding your custom directives. Read [httpin - custom directives](https://ggicci.github.io/httpin/directives/custom) for more details.
## Add Httpin Directives by Tagging the Struct Fields with `in`
```go
type ListUsersInput struct {
Token string `in:"query=access_token;header=x-access-token"`
Page int `in:"query=page;default=1"`
PerPage int `in:"query=per_page;default=20"`
IsMember bool `in:"query=is_member"`
Search *string `in:"query=search;omitempty"`
}
```
## How to decode an HTTP request to Go struct?
```go
func ListUsers(rw http.ResponseWriter, r *http.Request) {
input := r.Context().Value(httpin.Input).(*ListUsersInput)
if input.IsMember {
// Do sth.
}
// Do sth.
}
```
## How to encode a Go struct to HTTP request?
```go
func SDKListUsers() {
payload := &ListUsersInput{
Token: os.Getenv("MY_APP_ACCESS_TOKEN"),
Page: 2,
IsMember: true,
}
// Easy to remember, http.NewRequest -> httpin.NewRequest
req, err := httpin.NewRequest("GET", "/users", payload)
// ...
}
```
## Why this package?
#### Compared with using `net/http` package
```go
func ListUsers(rw http.ResponseWriter, r *http.Request) {
page, err := strconv.ParseInt(r.FormValue("page"), 10, 64)
if err != nil {
// Invalid parameter: page.
return
}
perPage, err := strconv.ParseInt(r.FormValue("per_page"), 10, 64)
if err != nil {
// Invalid parameter: per_page.
return
}
isMember, err := strconv.ParseBool(r.FormValue("is_member"))
if err != nil {
// Invalid parameter: is_member.
return
}
// Do sth.
}
```
| Benefits | Before (use net/http package) | After (use ggicci/httpin package) |
| ----------------------- | ------------------------------------------ | ---------------------------------------------------------------------------------------------- |
| ⌛️ Developer Time | 😫 Expensive (too much parsing stuff code) | 🚀 **Faster** (define the struct for receiving input data and leave the parsing job to httpin) |
| ♻️ Code Repetition Rate | 😞 High | 😍 **Lower** |
| 📖 Code Readability | 😟 Poor | 🤩 **Highly readable** |
| 🔨 Maintainability | 😡 Poor | 🥰 **Highly maintainable** |
## Alternatives and Similars
- [gorilla/schema](https://github.com/gorilla/schema): converts structs to and from form values
- [google/go-querystring](https://github.com/google/go-querystring): encoding structs into URL query parameters
