RustAPI Documentation
August 11, 2026 · View on GitHub
Central index for user guides, architecture notes, and open-source contribution paths.
Current release: rustapi-rs 0.2.0 · Changelog · All releases
Start here
| Document | Description |
|---|---|
| Golden Path | Handler → OpenAPI → probes → MCP/deploy (canonical story) |
| Getting Started | First API tutorial + feature table |
| Cookbook | Recipes, crate deep dives, learning paths |
| Features | Feature reference |
| Community & Contributing | How to get help, contribute, and report issues |
Architecture & design
| Document | Description |
|---|---|
| Philosophy | Design principles |
| Architecture | Internal structure |
| Performance Benchmarks | Methodology and published claims |
| Public API Contract | Stability and semver expectations |
Production
| Document | Description |
|---|---|
| Golden Path | Smallest recommended service shape |
| Production Baseline | Recommended defaults (production_defaults, probes, middleware) |
| Production Checklist | Pre-deploy and rollout checklist |
| Cookbook: Deployment | Docker, Fly.io, Railway, Shuttle, K8s |
| Cookbook: RustAPI Cloud | Managed hosting via CLI |
| Cookbook: Observability | Metrics, tracing, health |
| Cookbook: Graceful Shutdown | Clean shutdown |
| Cookbook: Replay | Request capture and replay |
CLI & tooling
| Document | Description |
|---|---|
| cargo-rustapi (Cookbook) | Full command reference |
| RustAPI Cloud backend | Self-hosted / managed cloud source |
Open source
| Document | Description |
|---|---|
| Contributing | Dev setup, tests, PR process |
| Code of Conduct | Community standards |
| Security | Vulnerability reporting |
| Community guide | Channels, doc locations, release cadence |
Examples
- Start:
golden_path+ GOLDEN_PATH.md - In-repo:
crates/rustapi-rs/examples/ - Full projects: rustapi-rs-examples
Quick start
[dependencies]
rustapi-rs = "0.2.0"
Alias for shorter macros (recommended):
[dependencies]
api = { package = "rustapi-rs", version = "0.2.0" }
use api::prelude::*;
#[derive(Serialize, Schema)]
struct Message { text: String }
#[api::get("/hello/{name}")]
async fn hello(Path(name): Path<String>) -> Json<Message> {
Json(Message { text: format!("Hello, {name}!") })
}
#[api::main]
async fn main() -> std::result::Result<(), Box<dyn std::error::Error + Send + Sync>> {
RustApi::auto().run("127.0.0.1:8080").await
}
Open http://127.0.0.1:8080/docs for auto-generated OpenAPI / Swagger UI.
Deploy to RustAPI Cloud
cargo install cargo-rustapi
cargo rustapi login
cargo rustapi deploy cloud
See RustAPI Cloud recipe for auth, status polling, and self-hosted backends.
License
MIT OR Apache-2.0, at your option.