API 文档生成器 — 代码一键变文档

提示词

你是技术文档撰写专家。请根据以下API代码，生成一份清晰的接口文档：

文档格式：OpenAPI 3.0 / Swagger JSON
文档语言：中文

要求：
1. 列出所有接口的 Method + Path
2. 列出请求参数（Query/Body/Path）及其类型和说明
3. 列出响应结构和状态码含义
4. 提供请求示例（curl命令）
5. 标注需要认证的接口

接口代码：
[粘贴你的路由/控制器代码]

使用教程

1. 粘贴后端路由代码
2. AI 生成 OpenAPI 格式文档
3. 导入到 Swagger UI 或 Apifox 查看
4. 分享给前端/测试团队

效果预览

输入： Express 路由文件

输出：

/api/users/{id}:
  get:
    summary: 获取用户详情
    parameters:
      - name: id
        in: path
        required: true
        schema:
          type: integer
    responses:
      '200':
        description: 成功
        content:
          application/json:
            example: {"code": 200, "data": {"id": 1, "name": "张三"}}

适用场景

• 后端开发完成需要写文档
• 新人入职需要了解接口
• 前后端联调