2023-07-18 19:48:38 +00:00
|
|
|
# server
|
2023-07-18 11:37:05 +00:00
|
|
|
|
2023-07-18 19:48:38 +00:00
|
|
|
HTTP server.
|
|
|
|
|
2024-03-07 17:09:51 +00:00
|
|
|
## Features
|
|
|
|
|
2024-03-15 09:06:17 +00:00
|
|
|
- High performance
|
2024-03-07 17:17:01 +00:00
|
|
|
- Low latency
|
|
|
|
- Radix tree routing
|
2024-03-07 17:09:51 +00:00
|
|
|
|
2023-07-18 19:48:38 +00:00
|
|
|
## Installation
|
|
|
|
|
|
|
|
```shell
|
|
|
|
go get git.akyoto.dev/go/server
|
|
|
|
```
|
|
|
|
|
2024-03-07 17:09:51 +00:00
|
|
|
## Usage
|
2023-07-18 19:48:38 +00:00
|
|
|
|
|
|
|
```go
|
|
|
|
s := server.New()
|
|
|
|
|
2024-03-07 17:17:01 +00:00
|
|
|
// Static route
|
2023-07-18 19:48:38 +00:00
|
|
|
s.Get("/", func(ctx server.Context) error {
|
|
|
|
return ctx.String("Hello")
|
|
|
|
})
|
|
|
|
|
2024-03-07 17:17:01 +00:00
|
|
|
// Parameter route
|
2023-07-22 09:54:13 +00:00
|
|
|
s.Get("/blog/:post", func(ctx server.Context) error {
|
|
|
|
return ctx.String(ctx.Get("post"))
|
|
|
|
})
|
|
|
|
|
2024-03-07 17:17:01 +00:00
|
|
|
// Wildcard route
|
2023-07-22 09:54:13 +00:00
|
|
|
s.Get("/images/*file", func(ctx server.Context) error {
|
|
|
|
return ctx.String(ctx.Get("file"))
|
|
|
|
})
|
2024-03-07 17:17:01 +00:00
|
|
|
|
2024-03-12 21:31:45 +00:00
|
|
|
s.Run(":8080")
|
2024-03-07 17:09:51 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
## Tests
|
|
|
|
|
|
|
|
```
|
|
|
|
PASS: TestRouter
|
2024-03-13 19:18:01 +00:00
|
|
|
PASS: TestMiddleware
|
2024-03-07 17:09:51 +00:00
|
|
|
PASS: TestPanic
|
2024-03-12 21:32:51 +00:00
|
|
|
PASS: TestRun
|
|
|
|
PASS: TestUnavailablePort
|
2024-03-07 17:09:51 +00:00
|
|
|
coverage: 100.0% of statements
|
|
|
|
```
|
|
|
|
|
|
|
|
## Benchmarks
|
|
|
|
|
|
|
|
```
|
2024-03-15 09:06:17 +00:00
|
|
|
BenchmarkStatic/#00-12 34907296 30.19 ns/op 0 B/op 0 allocs/op
|
|
|
|
BenchmarkStatic/hello-12 27628322 40.89 ns/op 0 B/op 0 allocs/op
|
|
|
|
BenchmarkStatic/hello/world-12 21330940 56.24 ns/op 0 B/op 0 allocs/op
|
|
|
|
BenchmarkGitHub/gists/:id-12 23608254 50.86 ns/op 0 B/op 0 allocs/op
|
|
|
|
BenchmarkGitHub/repos/:a/:b-12 18912602 59.02 ns/op 0 B/op 0 allocs/op
|
2024-03-07 17:09:51 +00:00
|
|
|
```
|
|
|
|
|
|
|
|
## License
|
|
|
|
|
|
|
|
Please see the [license documentation](https://akyoto.dev/license).
|
|
|
|
|
|
|
|
## Copyright
|
|
|
|
|
|
|
|
© 2023 Eduard Urbach
|