https://github.com/mythrnr/httprouter-group
For defining grouped routing with `julienschmidt/httprouter`.
https://github.com/mythrnr/httprouter-group
go httprouter router
Last synced: 3 months ago
JSON representation
For defining grouped routing with `julienschmidt/httprouter`.
- Host: GitHub
- URL: https://github.com/mythrnr/httprouter-group
- Owner: mythrnr
- License: mit
- Created: 2021-03-25T14:33:43.000Z (about 5 years ago)
- Default Branch: master
- Last Pushed: 2026-01-11T16:35:01.000Z (5 months ago)
- Last Synced: 2026-01-11T19:44:11.846Z (5 months ago)
- Topics: go, httprouter, router
- Language: Go
- Homepage: https://pkg.go.dev/github.com/mythrnr/httprouter-group
- Size: 107 KB
- Stars: 5
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.jp.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# httprouter-group
[English](./README.md)
## Status
[](https://github.com/mythrnr/httprouter-group/actions/workflows/check-code.yaml)
[](https://github.com/mythrnr/httprouter-group/actions/workflows/scan-vulnerabilities.yaml)
## Description
[`mythrnr/httprouter-group`](https://github.com/mythrnr/httprouter-group) は
[`julienschmidt/httprouter`](https://github.com/julienschmidt/httprouter) にルーティングをグループ化して定義する機能を追加する.
詳細は [GoDoc](https://pkg.go.dev/github.com/mythrnr/httprouter-group) を参照
## Feature
### [`RouteGroup`](https://github.com/mythrnr/httprouter-group/blob/master/route_group.go)
- `(*RouteGroup).Children(...*RouteGroup)` で登録した `RouteGroup`
は親のパスとミドルウェアを引き継ぐことができる.
- `mythrnr/httprouter-group` は定義を簡素化するためのもので, 次の例の通り
`julienschmidt/httprouter` のパフォーマンスには影響を与えない.
```go
package main
import (
"fmt"
"log"
"net/http"
"github.com/julienschmidt/httprouter"
group "github.com/mythrnr/httprouter-group"
)
// This definition provides following routes.
//
// - `GET /` with middleware 1
// - `GET /users` with middleware 1, 2
// - `GET /users/:id` with middleware 1, 2
// - `PUT /users/:id` with middleware 1, 3
// - `DELETE /users/:id` with middleware 1, 3
//
func main() {
// first, define routes, handlers, and middlewares.
g := group.New("/").GET(
func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
w.Write([]byte("GET /\n"))
},
).Middleware(
func(h httprouter.Handle) httprouter.Handle {
return func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
w.Write([]byte("Middleware 1: before\n"))
h(w, r, p)
w.Write([]byte("Middleware 1: after\n"))
}
},
).Children(
group.New("/users").GET(
func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
w.Write([]byte("GET /users\n"))
},
).Middleware(
func(h httprouter.Handle) httprouter.Handle {
return func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
w.Write([]byte("Middleware 2: before\n"))
h(w, r, p)
w.Write([]byte("Middleware 2: after\n"))
}
},
).Children(
group.New("/:id").GET(
func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
w.Write([]byte("GET /users/:id\n"))
},
),
),
group.New("/users/:id").PUT(
func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
w.Write([]byte("PUT /users/:id\n"))
},
).DELETE(
func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
w.Write([]byte("DELETE /users/:id\n"))
},
).Middleware(
func(h httprouter.Handle) httprouter.Handle {
return func(w http.ResponseWriter, r *http.Request, p httprouter.Params) {
w.Write([]byte("Middleware 3: before\n"))
h(w, r, p)
w.Write([]byte("Middleware 3: after\n"))
}
},
),
)
// next, set up and configure router.
router := httprouter.New()
router.PanicHandler = func(w http.ResponseWriter, r *http.Request, rec any) {
log.Fatal(rec)
}
// logging.
//
// GET /
// GET /users
// DELETE /users/:id
// GET /users/:id
// PUT /users/:id
fmt.Println(g.Routes().String())
// finally, register routes to httprouter instance.
for _, r := range g.Routes() {
router.Handle(r.Method(), r.Path(), r.Handler())
}
// serve.
log.Fatal(http.ListenAndServe(":8080", router))
}
```
## Requirements
- Go 1.24 以上.
- Docker (開発時)
## Install
Get it with `go get`.
```bash
go get github.com/mythrnr/httprouter-group
```