Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/gernest/alien
A lightweight and fast http router from outer space
https://github.com/gernest/alien
aliens golang http lightweight router
Last synced: 3 days ago
JSON representation
A lightweight and fast http router from outer space
- Host: GitHub
- URL: https://github.com/gernest/alien
- Owner: gernest
- License: mit
- Created: 2016-01-30T23:23:10.000Z (almost 9 years ago)
- Default Branch: master
- Last Pushed: 2024-03-24T14:59:06.000Z (9 months ago)
- Last Synced: 2024-12-06T13:43:07.669Z (16 days ago)
- Topics: aliens, golang, http, lightweight, router
- Language: Go
- Homepage:
- Size: 47.9 KB
- Stars: 132
- Watchers: 5
- Forks: 15
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
- awesome-go - alien - A lightweight and fast http router from outer space - ★ 95 (Web Frameworks)
- awesome-go-extra - alien - 01-30T23:23:10Z|2019-03-23T07:13:30Z| (Web Frameworks / Routers)
README
# Alien [](https://coveralls.io/github/gernest/alien?branch=master) [](https://travis-ci.org/gernest/alien) [](https://godoc.org/github.com/gernest/alien) [](https://goreportcard.com/report/github.com/gernest/alien)
Alien is a lightweight http router( multiplexer) for Go( Golang ), made for
humans who don't like magic.
Documentation [docs](https://godoc.org/github.com/gernest/alien)
# Features
* fast ( see the benchmarks, or run them yourself)
* lightweight ( just [a single file](alien.go) read all of it in less than a minute)
* safe( designed with concurrency in mind)
* middleware support.
* routes groups
* no external dependency( only the standard library )
# Motivation
I wanted a simple, fast, and lightweight router that has no unnecessary overhead
using the standard library only, following good practices and well tested code(
Over 90% coverage)
# Installation
```bash
go get github.com/gernest/alien
```
# Usage
## normal static routes
```go
package main
import (
"log"
"net/http"
"github.com/gernest/alien"
)
func main() {
m := alien.New()
m.Get("/", func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("hello world"))
})
log.Fatal(http.ListenAndServe(":8090", m))
}
```
visiting your localhost at path `/` will print `hello world`
## named params
```go
package main
import (
"log"
"net/http"
"github.com/gernest/alien"
)
func main() {
m := alien.New()
m.Get("/hello/:name", func(w http.ResponseWriter, r *http.Request) {
p := alien.GetParams(r)
w.Write([]byte(p.Get("name")))
})
log.Fatal(http.ListenAndServe(":8090", m))
}
```
visiting your localhost at path `/hello/tanzania` will print `tanzania`
## catch all params
```go
package main
import (
"log"
"net/http"
"github.com/gernest/alien"
)
func main() {
m := alien.New()
m.Get("/hello/*name", func(w http.ResponseWriter, r *http.Request) {
p := alien.GetParams(r)
w.Write([]byte(p.Get("name")))
})
log.Fatal(http.ListenAndServe(":8090", m))
}
```
visiting your localhost at path `/hello/my/margicl/sheeplike/ship` will print
`my/margical/sheeplike/ship`
## middlewares
Middlewares are anything that satisfy the interface
`func(http.Handler)http.Handler` . Meaning you have thousands of middlewares at
your disposal, you can use middlewares from many golang http frameworks on
alien(most support the interface).
```go
package main
import (
"log"
"net/http"
"github.com/gernest/alien"
)
func middleware(h http.Handler) http.Handler {
return http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) {
w.Write([]byte("hello middlware"))
})
}
func main() {
m := alien.New()
m.Use(middleware)
m.Get("/", func(_ http.ResponseWriter, _ *http.Request) {
})
log.Fatal(http.ListenAndServe(":8090", m))
}
```
visiting your localhost at path `/` will print `hello middleware`
## groups
You can group routes
```go
package main
import (
"log"
"net/http"
"github.com/gernest/alien"
)
func main() {
m := alien.New()
g := m.Group("/home")
m.Use(middleware)
g.Get("/alone", func(w http.ResponseWriter, _ *http.Request) {
w.Write([]byte("home alone"))
})
log.Fatal(http.ListenAndServe(":8090", m))
}
```
visiting your localhost at path `/home/alone` will print `home alone`
# Contributing
Start with clicking the star button to make the author and his neighbors happy. Then fork the repository and submit a pull request for whatever change you want to be added to this project.
If you have any questions, just open an issue.
# Author
Geofrey Ernest [@gernesti](https://twitter.com/gernesti) on twitter
# Licence
MIT see [LICENSE](LICENSE)