nitro-api-development
Installation
SKILL.md
Nitro v3 接口开发技能规范
本技能用于指导使用 Nitro v3 框架编写服务端接口,包括项目初始化、配置、接口编写规范、数据库交互和多平台部署等完整流程。
1. 适用场景
- 纯后端 Nitro 项目初始化:对非 Vite 的 Node.js 项目,初始化 Nitro 示例代码和配置
- Vite 项目全栈化:对 Vite 项目,初始化 Nitro 接口和配置,赋予全栈能力
- 接口开发与维护:按规范编写 Nitro v3 格式的接口代码
- Mock 数据迁移到真实数据库:将旧的 Mock 接口迁移到 Drizzle ORM + 真实数据库
- 多平台部署:适配 Cloudflare Worker、Vercel 等平台的环境变量和数据库连接
2. 核心原则 [CRITICAL]
- 框架 (Framework): 使用 Nitro v3 和 H3 事件处理器 (
defineHandler)。 - 数据库 (Database): 推荐使用 Drizzle ORM 进行所有数据库交互。新开发不建议使用 Mock JSON 文件。
- 响应格式 (Response Format): 必须严格遵循
ApiResponse和PageData结构返回{ success, code, message, data }。类型定义参见 templates/types.ts。 - 错误处理 (Error Handling): 所有 Handler 必须使用
try-catch包裹全部业务逻辑,catch 块返回标准化错误响应。 - 无状态 (Stateless): 保持 API 处理器无状态,所有数据持久化必须通过数据库。