vespera
为Rust Axum框架提供零配置、FastAPI风格的OpenAPI开发体验。
安装使用
复制下面这段提示词发给你的 AI(Claude / Cursor / TRAE / Codex / WorkBuddy 等),它会自动帮你完成安装:
帮我安装这个 AI Skill:vespera。 它的用途是:为Rust Axum框架提供零配置、FastAPI风格的OpenAPI开发体验。 完整的 Skill 内容见:https://321skill.com/skills/vespera/raw/index.md 请读取该页面内容,如果是 SKILL.md 格式直接安装,如果是 README 提炼核心 prompt 后安装。
提示词包含完整的 Skill 内容链接,AI 读取后即可完成安装。你也可以 查看完整内容 确认无误。
使用示例
‘我需要用Rust Axum快速创建一个用户管理API,并自动生成OpenAPI文档。’ 它会引导你使用Vespera:首先添加依赖,然后按照文件结构创建`routes/users.rs`并定义带有`#[vespera::route]`宏的处理函数,最后在主函数中调用`vespera!`宏启动服务,即可在`/docs`路径访问完整的交互式API文档。
介绍
Vespera是一个用于Rust Axum Web框架的库,旨在解决手动编写OpenAPI文档和路由注册的繁琐问题。它通过文件系统自动映射路由,并在编译时生成完整的OpenAPI 3.1规范,极大简化了API开发流程。
使用方式非常直观:开发者只需在路由处理函数上添加#[vespera::route]属性宏,并在主函数中使用vespera!宏初始化应用,即可自动获得Swagger UI文档界面和OpenAPI JSON文件,无需手动编写路由注册代码。
该工具特别适合使用Rust Axum框架进行Web后端开发的工程师,尤其是那些需要快速构建标准化、文档齐全的RESTful API的团队或个人开发者。
建议在项目初期就引入Vespera,以充分利用其自动生成文档的优势。需要注意的是,它深度集成于Axum框架,如果你的项目使用其他Rust Web框架,则无法直接使用。
核心特点
与手动编写或使用其他OpenAPI生成工具相比,Vespera的核心区别在于提供了类似Python FastAPI的“零配置”体验,通过文件结构自动映射路由,并提供了`.serve()`这样的便捷服务器启动方法,将路由注册、文档生成和服务器启动等多个步骤封装为极简的API。
注意事项
该Skill深度绑定Axum框架,不适合使用其他Rust Web框架(如Rocket、Actix-web)的项目。
常见问题
Vespera支持哪些HTTP方法?
支持所有标准HTTP方法,如GET、POST、PUT、DELETE等,通过`#[vespera::route(get/post/...)]`属性指定。
生成的OpenAPI文档可以自定义吗?
可以,通过`vespera!`宏的参数(如`title`、`version`)以及路由属性中的`description`、`tags`等字段进行自定义。
给 AI 助手的安装指引
如果你的 AI 编程助手(Claude Code、Cursor、TRAE 等)能看到这个页面,把下面这段发给它即可自动完成安装:
请访问 https://321skill.com/skills/vespera/raw/index.md 读取 vespera 的原始 Skill 定义(Markdown 格式),按其中说明在我的环境里完成安装和配置。
AI 可直接读取的原始 Markdown 地址:/skills/vespera/raw/index.md(查看排版版本)