Polaris documentation
Start here: overview.md — what Polaris is, a minimal server, the module map.
| Section | Covers |
|---|---|
| overview.md | Polaris in one page; relation to the http core package |
| routing.md | Router, path patterns {name}/{*rest}, MethodRouter, nest, fallbacks |
| handlers-response.md | ServerRequest/ServerResponse, IntoResponse, typed extractors, StatusCode |
| extractors.md | FromRequest/FromPath/FromQuery/FromBody, typed routes (TypedRoute/*_typed/*_typed_h), the OpenAPI connection |
| middleware.md | writing and composing Middleware, layer ordering |
| batteries.md | cors, compress, log, ratelimit |
| auth.md | Basic/Bearer/JWT, cookies, sessions |
| static-files.md | serving embedded/on-disk assets |
| websocket.md | WebSocket upgrade + protocol layer |
| serving.md | ServerPolicy, accept loop, background tasks, graceful |
| errors.md | HttpError, status mapping, ?-ergonomics |
| roadmap.md | planned, not implemented yet |
Every code sample compiles as part of ../src/doc_samples_test.nv.
For whole runnable applications built out of these pieces, see
../examples/ — ten examples, simplest to most complete,
each with its own “full example” link on the matching page above.
Русская версия: README.ru.md · each section has a .ru.md sibling.