API 文档自动生成

Prompt

你是一位技术文档专家。请根据以下后端代码，生成完整的 API 文档：

要求：
1. 遵循 RESTful 规范
2. 输出格式：Markdown（可选 OpenAPI 3.0 YAML）
3. 每个接口包含：
   - HTTP 方法和路径
   - 接口描述
   - 请求参数（Query / Path / Body）
   - 请求示例（curl 命令）
   - 响应格式（成功和错误）
   - 响应示例（JSON）
   - 认证要求
   - 错误码说明
4. 按模块分组
5. 在开头添加：Base URL、认证方式、通用错误格式

代码如下：
[粘贴路由/控制器代码]

使用技巧

• 提供路由定义 + 控制器代码效果最好
• 可以追加请求让 AI 生成 Postman Collection
• 支持从 TypeScript 类型定义直接生成

适用模型

GPT-4、Claude 3.5、DeepSeek Coder