# Examples
Every example runs with:
```text
cargo run -p kynos --example <name>
```
The **Features** column is what to append as `--features …` when an example
needs more than the defaults. Each file's own header explains why it needs them.
## Start here
| [`hello.rs`](hello.rs) | The whole path from an `async fn` to a served, described operation | — |
## Describing types
| [`schema.rs`](schema.rs) | `#[derive(Schema)]`: constraints, serde interop, map keys, and the escape hatch | — |
| [`scalars.rs`](scalars.rs) | Which types outside `std` map to which JSON Schema `format` | `uuid,time-chrono,time-jiff,decimal-rust,decimal-big` |
## Requests
| [`parameters.rs`](parameters.rs) | Path, query, header and cookie groups, plus a hand-written extractor | `cookie` |
| [`payloads.rs`](payloads.rs) | Every request body codec, and the three shapes binary content takes | `form,multipart` |
| [`protobuf.rs`](protobuf.rs) | Protocol Buffers as a request and a response body | `protobuf` |
## Responses
| [`responses.rs`](responses.rs) | Status in the return type: `Created`, `Accepted`, `Redirect<CODE>`, `Reply`, `WithHeaders`, typed URIs | — |
| [`negotiation.rs`](negotiation.rs) | Choosing a representation from the client's `Accept` header | — |
| [`localization.rs`](localization.rs) | Choosing a language from `Accept-Language`, and why that field *is* a parameter where `Accept` is not | — |
| [`errors.rs`](errors.rs) | `#[derive(ApiError)]`, RFC 9457 problem documents, and every other way a status reaches an operation | — |
| [`localized_errors.rs`](localized_errors.rs) | Translating a problem's `title` from the application's own catalogue, including the rejections Kynos raises | — |
| [`sse.rs`](sse.rs) | Server-Sent Events: discriminated event types, resumption, reconnection advice, keep-alive | `openapi32`, `compression` |
| [`streaming.rs`](streaming.rs) | JSON Lines, JSON text sequences, byte streams, and the whole-query-string parameter | `openapi32` |
## Structure
| [`composition.rs`](composition.rs) | `nest` versus `merge` versus `Group`, the four tag scopes, and the fallback policies | — |
| [`state.rs`](state.rs) | Compile-time dependency injection: `#[derive(Provider)]` and `Inject<T>` | — |
| [`document.rs`](document.rs) | Document metadata, validation, version refusal, and serving the description as a route | `openapi32,yaml` |
## Middleware
| [`middleware.rs`](middleware.rs) | Writing an interceptor, and the ones Kynos ships | `compression` |
| [`decompression.rs`](decompression.rs) | Accepting a compressed request body: the direction `Accept-Encoding` says nothing about, and why `BodySize` cannot guard it | `compression` |
| [`cache.rs`](cache.rs) | A shared response cache over a store Kynos does not ship: what may be stored, what may not, and why `Conditional` goes outside | `cache` |
| [`rate_limit.rs`](rate_limit.rs) | Named quotas over a counter store Kynos does not ship: a sliding window, several windows at once, and both header spellings | — |
| [`token_bucket.rs`](token_bucket.rs) | The other half of the pair: replacing the *algorithm* rather than the store, over an injected clock its own tests drive | — |
| [`cors.rs`](cors.rs) | The two exchanges a browser makes, the preflight nothing declares, and the configuration that is refused | — |
| [`csrf.rs`](csrf.rs) | Refusing a forged cross-site write with no token and no session, and the cookie the refusal protects | `cookie` |
| [`tracing.rs`](tracing.rs) | Spans reaching a real subscriber, and why an observer declares nothing | — |
| [`opentelemetry.rs`](opentelemetry.rs) | Distributed tracing that leaves the process: a W3C Trace Context group that is also the propagation carrier, and why this is an example rather than middleware | — |
| [`print_request_response.rs`](print_request_response.rs) | An interceptor buffering both bodies, and what reading them costs the description | — |
## Security
| [`security_schemes.rs`](security_schemes.rs) | Every kind of security scheme as a type, from `Auth<S>` to the emitted requirement | — |
| [`jwt.rs`](jwt.rs) | A JWT verifier the framework does not ship: claims as a typed credential, `kid` rotation, scopes, optional auth, and a token endpoint | — |
| [`tls.rs`](tls.rs) | Serving over TLS: client certificates, SNI, and the HTTP/1 and HTTP/2 configs ALPN chooses between | `tls` |
## Serving
| [`graceful_shutdown.rs`](graceful_shutdown.rs) | Every shutdown trigger, the drain deadline, and reading the bound addresses | — |
| [`auto_reload.rs`](auto_reload.rs) | Inheriting a listening socket so a rebuild does not drop it | — |
| [`docs_ui.rs`](docs_ui.rs) | A Scalar or Redoc reference mounted in one line, dropped by `--release`, and what mounting it costs the document | `docs` |
| [`ranged.rs`](ranged.rs) | Ranged delivery over a source that is not a filesystem, which is the case `assets` cannot cover | — |
## Testing and escape hatches
| [`testing.rs`](testing.rs) | Driving the service in-process, and proving the description is truthful | `test-util` |
| [`assets.rs`](assets.rs) | Both ways to serve files: an embedded set that is fully described, and a directory that is recorded instead | `assets-fs` |
| [`unchecked.rs`](unchecked.rs) | The escape hatches, and what using one costs the document | `unchecked` |
## Elsewhere
[`crates/kynos-openapi/examples/standalone.rs`](../../kynos-openapi/examples/standalone.rs)
builds and validates a description with no server anywhere in sight. Run it with
`cargo run -p kynos-openapi --example standalone --features openapi32,yaml`.