go/httpin
1
0
Fork 0
mirror of https://github.com/ggicci/httpin.git synced 2025-02-21 19:06:46 +02:00
Code Issues Releases Activity

chore(docs): tiny update to README

Browse Source
This commit is contained in:
Ggicci 2024-05-20 18:56:14 -04:00
parent eed0621e7f
commit de7db1bbe1
1 changed files with 6 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
README.md
View File

@ -48,7 +48,7 @@ Since v0.15.0, httpin also supports creating an HTTP request (`http.Request`) fr
- **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. - **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. - **extensible** (advanced feature): by adding your custom directives. Read [httpin - custom directives](https://ggicci.github.io/httpin/directives/custom) for more details.
## How to decode an HTTP request to Go struct? ## Add Httpin Directives by Tagging the Struct Fields with `in`
```go ```go
type ListUsersInput struct { type ListUsersInput struct {
@ -56,9 +56,13 @@ type ListUsersInput struct {
Page int `in:"query=page;default=1"` Page int `in:"query=page;default=1"`
PerPage int `in:"query=per_page;default=20"` PerPage int `in:"query=per_page;default=20"`
IsMember bool `in:"query=is_member"` IsMember bool `in:"query=is_member"`
Search *string `in:"query=search;omitempty"` Search *string `in:"query=search;omitempty"`
} }
```
## How to decode an HTTP request to Go struct?
```go
func ListUsers(rw http.ResponseWriter, r *http.Request) { func ListUsers(rw http.ResponseWriter, r *http.Request) {
input := r.Context().Value(httpin.Input).(*ListUsersInput) input := r.Context().Value(httpin.Input).(*ListUsersInput)
@ -72,13 +76,6 @@ func ListUsers(rw http.ResponseWriter, r *http.Request) {
## How to encode a Go struct to HTTP request? ## How to encode a Go struct to HTTP request?
```go ```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"`
}
func SDKListUsers() { func SDKListUsers() {
payload := &ListUsersInput{ payload := &ListUsersInput{
Token: os.Getenv("MY_APP_ACCESS_TOKEN"), Token: os.Getenv("MY_APP_ACCESS_TOKEN"),