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
Add comprehensive documentation and update examples
Added detailed documentation files: ARCHITECTURE.md, FEATURES.md, GETTING_STARTED.md, and PHILOSOPHY.md under the docs directory, as well as a new image asset. Updated README.md to include philosophy and documentation links. Modified hello-world example to align with new documentation and API surface. These changes provide a complete overview, feature reference, and onboarding guide for RustAPI.
Copy file name to clipboardExpand all lines: README.md
+40Lines changed: 40 additions & 0 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -18,6 +18,46 @@ RustAPI redefines **API development for the AI era**.
18
18
19
19
We combine Rust's performance and safety with FastAPI's ergonomics. Write type-safe, production-ready APIs without fighting trait bounds. **MCP servers**, **LLM integrations**, or classic REST APIs — one framework for all.
20
20
21
+
---
22
+
23
+
## Philosophy
24
+
25
+
> *"API surface is ours, engines can change."*
26
+
27
+
RustAPI follows a **Facade Architecture** — a stable, ergonomic public API that shields you from internal complexity and breaking changes.
28
+
29
+
### Core Principles
30
+
31
+
| Principle | What It Means |
32
+
|-----------|---------------|
33
+
|**🎯 5-Line APIs**| A working REST endpoint in 5 lines. No ceremony. |
34
+
|**🛡️ Stable Surface**| Your code depends on `rustapi-rs`. Internal crates (`hyper`, `tokio`, `validator`) are implementation details. |
35
+
|**🔄 Engines Change**| We can swap `hyper` for `h3`, upgrade `tokio`, or replace `validator` — your code stays the same. |
36
+
|**🎁 Batteries Included**| JWT, CORS, Rate Limiting, OpenAPI — all built-in, all optional via feature flags. |
37
+
|**🤖 LLM-First**| TOON format, token counting headers, MCP-ready. Built for the AI era. |
0 commit comments