Welcome to the RustAPI Architecture Cookbook. This documentation is designed to be the single source of truth for the project's philosophy, patterns, and practical implementation details.
Note
This is a living document. As our architecture evolves, so will this cookbook.
This is not just API documentation. This is a collection of:
- Keynotes: High-level architectural decisions and "why" we made them.
- Patterns: The repeated structures (like
ActionandService) that form the backbone of our code. - Recipes: Practical, step-by-step guides for adding features, testing, and maintaining cleanliness.
- Learning Paths: Structured progressions with real-world examples.
Looking for hands-on learning? Check out our Examples Repository with 18 complete projects:
| Category | Examples |
|---|---|
| Getting Started | hello-world, crud-api |
| Authentication | auth-api (JWT), rate-limit-demo |
| Database | sqlx-crud, event-sourcing |
| AI/LLM | toon-api, mcp-server |
| Real-time | websocket, graphql-api |
| Production | microservices, serverless-lambda |
👉 See Learning & Examples for structured learning paths.
This cookbook is styled with the RustAPI Premium Dark theme, focusing on readability, contrast, and modern "glassmorphism" aesthetics.
- Want to add a feature? Jump to Adding a New Feature.
- Want to understand performance? Read Performance Philosophy.
- Need to check code quality? See Maintenance.
- New to RustAPI? Follow our Learning Paths.