rustapi-rs 0.1.450

A FastAPI-like web framework for Rust - DX-first, type-safe, batteries included
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103

# RustAPI Examples


This directory contains the in-repository examples for the `rustapi-rs` facade crate.

## Available examples


### `auth_api`


Shows cookie-backed login, session refresh, logout, and session inspection using the built-in session middleware.

Run it with:

```sh
cargo run -p rustapi-rs --example auth_api --features extras-session
```

Then try:

- `POST http://127.0.0.1:3000/auth/login` with `{"user_id":"demo-user"}`
- `GET http://127.0.0.1:3000/auth/me`
- `POST http://127.0.0.1:3000/auth/refresh`
- `POST http://127.0.0.1:3000/auth/logout`

### `full_crud_api`


Shows a compact in-memory CRUD API with list/create/read/update/delete routes.

Run it with:

```sh
cargo run -p rustapi-rs --example full_crud_api
```

Then try:

- `GET http://127.0.0.1:3000/todos`
- `POST http://127.0.0.1:3000/todos`
- `GET http://127.0.0.1:3000/todos/1`
- `PATCH http://127.0.0.1:3000/todos/1`
- `DELETE http://127.0.0.1:3000/todos/1`

### `streaming_api`


Shows Server-Sent Events (SSE) with a small progress feed.

Run it with:

```sh
cargo run -p rustapi-rs --example streaming_api
```

Then open:

- `http://127.0.0.1:3000/events`

### `jobs_api`


Shows an in-memory job queue, enqueue endpoint, and manual worker tick endpoint.

Run it with:

```sh
cargo run -p rustapi-rs --example jobs_api --features extras-jobs
```

Then try:

- `POST http://127.0.0.1:3000/jobs/email`
- `POST http://127.0.0.1:3000/jobs/process-next`
- `GET http://127.0.0.1:3000/jobs/stats`

### `typed_path_poc`


Shows typed path definitions, type-safe route registration, and URI generation with `TypedPath`.

Run it with:

```sh
cargo run -p rustapi-rs --example typed_path_poc
```

### `status_demo`


Shows the automatic status page and a few endpoints that generate traffic, latency, and failures for demonstration purposes.

Run it with:

```sh
cargo run -p rustapi-rs --example status_demo
```

Then open:

- `http://127.0.0.1:3000/status`
- `http://127.0.0.1:3000/fast`
- `http://127.0.0.1:3000/slow`
- `http://127.0.0.1:3000/flaky`

## Notes


- Keep this file aligned with the actual `.rs` files in this directory.
- User-facing examples should import from `rustapi_rs::prelude::*` unless the example is explicitly about internals.
- Additional example ideas tracked in `tasks.md` are roadmap items until their files exist here.