Rust API Examples

RustAPI示例

   

生产就绪示例 展示了 RustAPI --具有类似FastAPI开发经验的Rust web框架。

📚 官方资源：

• 🔗 RustAPI框架 --主存储库
• 📖 烹饪手册文档 --全面的指南和食谱
• 💬 讨论 --社区支持

______________________________________________________________________

🚀 为什么选择RustAPI？

*“Rust速度。Python简单。AI效率。”*

主要特点

• 🎯 零沸点板 — RustApi::auto() 自动发现所有路线
• 📝 汽车文档 --OpenAPI/Swagger /docs 开箱即用
• ✅ 内置验证 — #[validate] 带有详细的错误信息
• 🔐 JWT身份验证 --头等舱 JwtLayer 和 AuthUser 提取器
• 🤖 AI优先架构 --TOON格式（节省50-58%的代币），支持MCP
• ⚡ 中间件堆栈 --速率限制、CORS、日志记录、断路器等
• 🌐 实时 --支持广播通道的WebSocket

______________________________________________________________________

📋 先决条件

在运行这些示例之前，请确保您已经：

# Rust 1.70 or later
rustc --version

# Clone the examples repository
git clone https://github.com/Tuntii/rustapi-rs-examples.git
cd rustapi-rs-examples

# Build all examples
cargo build --release

可选依赖关系 （具体示例）：

• 码头工人 --For sqlx-crud （PostgreSQL/SQLite）
• SQLite --For sqlx-crud 本地测试

______________________________________________________________________

📂 示例概述

此存储库包含 18个生产就绪示例 按类别组织：

🌟 入门指南

🔐 身份验证和安全

🗄️ 数据库集成

🤖 AI和LLM集成

🌐 实时和网络

🏗️ 高级体系结构

⚠️ 备注: serverless-lambda 使用AWS Lambda HTTP运行时而不是RustAPI进行无服务器部署模式。

______________________________________________________________________

🎯 功能覆盖矩阵

______________________________________________________________________

📊 RustAPI功能标志

每个示例都使用特定的Cargo特征标志。看 功能.md 详细文档。

______________________________________________________________________

🚀 快速开始

运行示例

# Navigate to repository
cd rustapi-rs-examples

# Run any example
cargo run -p hello-world

# Run with debug logging
RUST_LOG=debug cargo run -p crud-api

# Access Swagger documentation (when running)
# http://127.0.0.1:8080/docs

测试API端点

# Hello World
curl http://127.0.0.1:8080/
curl http://127.0.0.1:8080/hello/RustAPI

# CRUD API
curl http://127.0.0.1:8080/users
curl -X POST http://127.0.0.1:8080/users \
  -H "Content-Type: application/json" \
  -d '{"name": "Alice", "email": "alice@example.com"}'

# Auth API
curl -X POST http://127.0.0.1:8080/login \
  -H "Content-Type: application/json" \
  -d '{"username": "admin", "password": "password"}'

______________________________________________________________________

📚 学习路径

要获得结构化的学习体验，请按照我们推荐的进度进行 学习路径.md:

1. hello-world     → Basic routing, responses
2. crud-api        → Validation, error handling, state management
3. auth-api        → JWT authentication, protected routes
4. middleware-chain → Custom middleware, composition
5. proof-of-concept → Full application architecture

______________________________________________________________________

🔗 食谱交叉引用

每个示例都映射到 RustAPI食谱:

______________________________________________________________________

📝 创造自己的榜样

1. 创建目录: my-example/

1. 添加Cargo.toml:

   [package]
   name = "my-example"
   version = "0.1.0"
   edition = "2021"

   [dependencies]
   rustapi-rs = { path = "../../crates/rustapi-rs", features = ["full"] }
   tokio = { version = "1", features = ["full"] }
   serde = { version = "1", features = ["derive"] }

1. 创建src/main.rs:

   use rustapi_rs::prelude::*;

   #[rustapi_rs::get("/")]
   async fn index() -> &'static str {
       "Hello from my example!"
   }

   #[tokio::main]
   async fn main() -> Result> {
       RustApi::auto().run("127.0.0.1:8080").await
   }

1. 运行它:

   cargo run -p my-example

______________________________________________________________________

🎯 路线图

即将推出

• \[ \] redis缓存 --Redis缓存层
• \[ \] sse活动 --服务器发送事件流
• \[ \] grpc集成 -gRPC+REST混合API
• \[ \] 分布式追踪 --OpenTetry集成
• \[ \] kubernetes就绪 --健康检查、指标、优雅关机

______________________________________________________________________

🤝 贡献

欢迎投稿！查看我们的 贡献指南 了解详情。

1. 分叉此存储库
2. 在新目录中创建示例
3. 添加全面的文档（README.md）
4. 提交拉取请求

______________________________________________________________________

📄 许可证

该项目的许可证为MIT OR Apache-2.0许可证，与 RustAPI.

______________________________________________________________________

建于❤️ 使用 RustAPI