https://github.com/matryer/way
HTTP routing for Go 1.7
https://github.com/matryer/way
Last synced: 19 days ago
JSON representation
HTTP routing for Go 1.7
- Host: GitHub
- URL: https://github.com/matryer/way
- Owner: matryer
- License: mit
- Created: 2016-07-28T08:49:05.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2022-11-27T23:36:36.000Z (over 2 years ago)
- Last Synced: 2025-04-09T16:20:02.577Z (19 days ago)
- Language: Go
- Size: 13.7 KB
- Stars: 196
- Watchers: 7
- Forks: 20
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Way
HTTP router for Go 1.7
* Deliberately simple
* Extremely fast
* Route based on HTTP methods and path
* Path parameters via `Context` (e.g. `/music/:band/:song`)
* Trailing `/` matches path prefixes
## Install
There's no need to add a dependency to Way, just copy `way.go` and `way_test.go` into your project, or [drop](https://github.com/matryer/drop) them in:
```
drop github.com/matryer/way
```
If you prefer, it is go gettable:
```
go get github.com/matryer/way
```
## Usage
* Use `NewRouter` to make a new `Router`
* Call `Handle` and `HandleFunc` to add handlers
* Specify HTTP method and path pattern for each route
* Use `Param` function to get the path parameters from the context
```go
func main() {
router := way.NewRouter()
router.HandleFunc("GET", "/music/:band/:song", handleReadSong)
router.HandleFunc("PUT", "/music/:band/:song", handleUpdateSong)
router.HandleFunc("DELETE", "/music/:band/:song", handleDeleteSong)
log.Fatalln(http.ListenAndServe(":8080", router))
}
func handleReadSong(w http.ResponseWriter, r *http.Request) {
band := way.Param(r.Context(), "band")
song := way.Param(r.Context(), "song")
// use 'band' and 'song' parameters...
}
```
* Prefix matching
To match any path that has a specific prefix, use the `...` prefix indicator:
```go
func main() {
router := way.NewRouter()
router.HandleFunc("GET", "/images...", handleImages)
log.Fatalln(http.ListenAndServe(":8080", router))
}
```
In the above example, the following paths will match:
* `/images`
* `/images/`
* `/images/one/two/three.jpg`
* Set `Router.NotFound` to handle 404 errors manually
```go
func main() {
router := way.NewRouter()
router.NotFound = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.WriteHeader(http.StatusNotFound)
fmt.Fprintf(w, "This is not the page you are looking for")
})
log.Fatalln(http.ListenAndServe(":8080", router))
}
```
## Why another HTTP router?
I know, I know. But no routers offer the simplicity of path parameters via Context, and HTTP method matching. Which covers 100% of my use cases so far.