You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
docs: open-source hub, community guide, and version sync
- Add docs/COMMUNITY.md for contributors and support channels
- Restructure docs/README.md as documentation hub
- README: community section, v0.1.537, dedupe quick-start
- Sync snippet versions and MSRV (1.85) across docs/cookbook
- CONTRIBUTING: documentation contribution guide
Copy file name to clipboardExpand all lines: README.md
+25-52Lines changed: 25 additions & 52 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -172,7 +172,7 @@ Current benchmark methodology and canonical published performance claims live in
172
172
173
173
```toml
174
174
[dependencies]
175
-
api = { package = "rustapi-rs", version = "0.1.507" }
175
+
api = { package = "rustapi-rs", version = "0.1.537" }
176
176
```
177
177
178
178
```rust
@@ -203,7 +203,7 @@ run_rustapi_and_mcp_with_shutdown(app, "0.0.0.0:8080", mcp, "0.0.0.0:9090", toki
203
203
204
204
Every tagged endpoint becomes an AI agent tool instantly.
205
205
206
-
> **Tip:**Crate'i `api` (veya`myapi`, `server` vs.) diye alias'lamak en temiz ve FastAPI benzeri deneyimi verir. Makrolar otomatik olarak `#[api::get]`, `#[api::post]`,`#[api::main]`şeklinde çalışır.
206
+
> **Tip:**Alias the crate as `api` (or`myapi`, `server`, etc.) for clean `#[api::get]` /`#[api::main]`macros — similar to FastAPI's import style.
207
207
208
208
For production deployments, you can enable standard probe endpoints without writing handlers manually:
Bu, hem daha okunabilir hem de FastAPI benzeri bir deneyim sağlar. Makro genişletme sırasında crate ismi otomatik olarak algılanır (`proc-macro-crate` sayesinde).
-**Crate consolidation (13 → 9):**`rustapi-testing`, `rustapi-jobs`, `rustapi-view`, and `rustapi-toon` merged into `rustapi-core` and `rustapi-extras` as feature-gated modules.
285
-
-**Embedded Isometric System Dashboard:** Live `/dashboard` with bento-grid layout, execution-flow visualization, and time-travel replay browser.
286
-
-**Native MCP (full featured):** In-process invocation (~28µs per call), `cargo rustapi mcp generate` for any OpenAPI spec, stdio transport, and improved cookbook coverage.
287
-
- Dual-stack runtime: simultaneous HTTP/1.1 (TCP) and HTTP/3 (QUIC/UDP)
| Getting started |[docs/GETTING_STARTED.md](docs/GETTING_STARTED.md)|
276
+
| Community & contributing |[docs/COMMUNITY.md](docs/COMMUNITY.md)|
277
+
| Production checklist |[docs/PRODUCTION_CHECKLIST.md](docs/PRODUCTION_CHECKLIST.md)|
278
+
| API reference |[docs.rs/rustapi-rs](https://docs.rs/rustapi-rs)|
305
279
306
-
## Documentation
280
+
**Examples:** in-repo [`crates/rustapi-rs/examples/`](crates/rustapi-rs/examples/) and the separate **[rustapi-rs-examples](https://github.com/Tuntii/rustapi-rs-examples)** repository.
307
281
308
-
Detailed architecture, recipes, and guides are in the [Cookbook](docs/cookbook/src/SUMMARY.md):
RustAPI is built in the open. Bug reports, docs fixes, recipes, and code contributions are welcome.
316
285
317
-
**Full standalone examples** (including a complete MCP tool example with in-process invocation) live in the separate **[rustapi-rs-examples](https://github.com/Tuntii/rustapi-rs-examples)** repository.
v0.1.537 completes the **issue #201 maintainability pass**: `app/builder.rs` is split into focused internal modules while keeping the public `rustapi-rs` API unchanged.
11
+
12
+
| Area | Change |
13
+
|------|--------|
14
+
| App modules |`routing`, `openapi`, `health`, `run` — all `src/**/*.rs` under 50KB |
15
+
| Run lifecycle |`on_shutdown` hooks run consistently on every `run*` entrypoint |
16
+
| Tests | Router/extract bodies in `tests/support/*_lib.rs` via `include!`|
17
+
| Public API | No breaking changes; `api/public` snapshots unchanged |
0 commit comments