RustAPI

✨ 欢迎来到 RustAPI，专为 AI 优先开发打造的 Rust API 框架！

---

💡 产品简介

RustAPI 是一款开源的 Rust API 框架，旨在让您的 AI 后端服务更具可读性、更易组合，并能直接投入生产。我们致力于消除传统 Actix/Axum 开发中常见的样板代码与繁琐流程，并通过针对 SSE、MCP 与 LLM 等实时与大模型工作流的优化，助您实现更高效的开发与更快的产品上线。

“API 界面属于我们，引擎可以更换。” RustAPI 采用 Facade 架构，提供稳定、符合人体工程学的公共 API，将您从内部复杂性和潜在的破坏性变更中解放出来。

---

🚀 核心优势与特性

✨ AI 时代的高效开发

• 🔥 5 行代码实现 API： 极简的工作流，快速搭建生产级 API 端点。
• 🤖 LLM 优先设计： 原生支持 TOON 格式（可为 LLM 节省 50-58% 的 token 消耗）、token 计数头部以及 MCP 就绪，为 AI 应用量身定制。
• ⚡ 实时与大模型优化： 针对 SSE（Server-Sent Events）、MCP（Model Control Protocol）及 LLM（Large Language Models）工作流进行深度优化，确保流畅的实时通信与大模型集成。

🛡️ 坚如磐石的架构

• 🔒 类 FastAPI 的人体工程学： 结合 Rust 的高性能与安全性，提供如 FastAPI 般友好的开发体验，无需与 trait bounds Struggle。
• 🛡️ 类型安全提取器： 通过 Json, Query, Path, WebSocket 等在编译时提供类型保证，有效减少运行时错误。
• 🔄 稳定且可进化的核心： 您的代码依赖于 rustapi-rs 的稳定 API，而内部实现（如 hyper, tokio, validator）可无缝升级或替换，不影响您的应用。

🎁 丰富的“开箱即用”功能

• 🛣️ 零配置路由： 通过宏装饰器自动注册路由 (RustApi::auto())，极大简化路由管理。
• 📝 自动 OpenAPI 文档： 根据您的代码自动生成 OpenAPI 文档，并默认在 /docs 端点提供 Swagger UI。
• ✅ 内置验证： 使用 #[validate(email)] 等注解实现自动验证，并返回友好的 422 错误响应。
• 🔑 JWT 认证： 通过 AuthUser 提取器，实现一行代码的 JWT 身份验证。
• 🌐 CORS 与限速： 内置生产级的 CORS 和 IP 限速中间件。
• 💬 WebSocket 支持： 提供完整的 WebSocket 协议支持，包含文本、二进制、Ping/Pong 消息与广播功能，无缝整合路由。
• 🖼️ 模板引擎： 支持基于 Tera 模板的服务器端 HTML 渲染。
• 🛠️ CLI 工具： 包含 cargo-rustapi 命令行工具，用于项目骨架生成等。

---

📚 快速体验

以下是一个简单的“Hello World”示例，展示 RustAPI 的简洁性：

use rustapi_rs::prelude::*;

#[rustapi_rs::get("/hello/{name}")]
async fn hello(Path(name): Path) -> Json {
    Json(Message { greeting: format!("Hello, {name}!") })
}

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

仅 5 行代码，就能获得一个生产级的 API，并自动生成 OpenAPI 文档！

---

🌍 开源社区

RustAPI 是一个开源项目，期待您的参与和贡献！无论您是提出问题、报告 Bug，还是提交新的功能，都欢迎加入我们的开发旅程。