go/httpin
1
0
Fork 0
mirror of https://github.com/ggicci/httpin.git synced 2024-11-28 08:49:05 +02:00
Code Issues Releases Activity

chore: up README

Browse Source
This commit is contained in:
Ggicci 2021-05-25 13:34:26 +08:00
parent 975e489a48
commit 09a7342e1a
1 changed files with 7 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
README.md
View File

@ -75,8 +75,6 @@ func ListUsers(rw http.ResponseWriter, r *http.Request) {
- [x] Register custom type decoders - [x] Register custom type decoders
- [x] Define an input struct with embedded struct fields - [x] Define an input struct with embedded struct fields
- [x] Builtin directive `required` to tag a field as **required** - [x] Builtin directive `required` to tag a field as **required**
- [ ] Builtin encoders for basic types
- [ ] Register custom type encoders
- [x] Register custom directive executors to extend the ability of field resolving, see directive [required](./required.go) as an example and think about implementing your own directives like `trim`, `to_lowercase`, `base58_to_int`, etc. - [x] Register custom directive executors to extend the ability of field resolving, see directive [required](./required.go) as an example and think about implementing your own directives like `trim`, `to_lowercase`, `base58_to_int`, etc.
## Sample User Defined Input Structs ## Sample User Defined Input Structs
@ -104,9 +102,7 @@ type ListUsersInput struct {
} }
``` ```
## Advanced ## Integrate with Go Native http.Handler (Use Middleware)
### Use middleware handlers to reduce much more trivial code
First, set up the middleware for your handlers (**bind Input vs. Handler**). We recommend using [alice](https://github.com/justinas/alice) to chain your HTTP middleware functions. First, set up the middleware for your handlers (**bind Input vs. Handler**). We recommend using [alice](https://github.com/justinas/alice) to chain your HTTP middleware functions.
@ -128,6 +124,12 @@ func ListUsers(rw http.ResponseWriter, r *http.Request) {
} }
``` ```
## Integrate with Popular Go Web Frameworks
Please read the [wiki](https://github.com/ggicci/httpin/wiki) for more information about using `httpin` in popular Go web frameworks, e.g. gin, fiber, revel, etc.
## Advanced
### 🔥 Extend `httpin` by adding custom directives ### 🔥 Extend `httpin` by adding custom directives
Know the concept of a `Directive`: Know the concept of a `Directive`:
@ -185,7 +187,3 @@ type Authorization struct {
``` ```
The directives will run in the order as they defined in the struct tag. The directives will run in the order as they defined in the struct tag.
## Articles
- [Decode HTTP Query Params into a Struct in Golang](https://ggicci.medium.com/decode-http-query-params-into-a-struct-in-golang-bbb07168ed14)