GPT中文小秘书挑几下就能开工
我积分

写接口文档初稿

关于「写接口文档初稿」:能拿到什么、要点选什么、怎么办

传源码或接口文件,5 分钟拿到排好版的接口文档初稿。根据代码注释或函数签名,自动生成符合团队规范的 Markdown 接口文档初稿。不替代人工校验,不保证逻辑正确性,需开发者复核后发布。

能拿到什么

  • 推荐:排好版的 Markdown 接口文档 + 一份 Word 版,参数表齐全、带请求响应示例(按接口分节,每个接口一张参数表、一段 JSON 示例,标题层级清晰),约 5 分钟
  • 旗舰:Markdown 接口文档、Word 版接口文档、错误码对照表、接口变更记录

要你点选的几项

语言框架、输入来源、上传源文件、要写进哪些内容、字段粒度、文档风格、响应处理、补充说明、格式要求、命名习惯。多数点一下就行,没选的按常见情况替你定,交付时说清哪几项是按默认的。

怎么办

  1. 选语言框架和输入来源
  2. 上传源码或接口文件
  3. 勾选要写的内容和风格
  4. 生成 Markdown 初稿下载

别人还这样说

  • 帮我把这堆 // @Summary 注释转成能发给前端的文档
  • 从 OpenAPI 文件一键生成带示例的 Markdown
直接说你要办的事。下面是别人怎么办的,点任何一项就换成你自己的。左边是别人怎么办的,右边是你的,点一项就开始改。
示范 · 别人这样说

「帮我把这个RESTful接口的参数、返回值整理成清晰的文档表格,我要发给前端同事看。」

替他选了:请求路径与方法、功能简述、Query 参数、Path 参数、Body 参数(JSON结构)、响应状态码、成功响应示例 · 所有字段含可选 · 联调版(给前端用) · success + error 示例 · 纯 Markdown(.md)

按示范选好的 点一项就变成你的

你的成品会在这里出现
示例成品 · 不是你的按示范写的,看个样子
# POST /api/v1/users ## 功能说明 创建新用户,需校验手机号唯一性 ## 请求参数 | 字段 | 类型 | 必填 | 说明 | |------|------|------|------| | name | string | 是 | 用户昵称,2~12字符 | | phone | string | 是 | 手机号,11位数字 | | avatar | string | 否 | 头像URL,支持HTTPS | ## 响应示例 ```json { "code": 0, "msg": "success", "data": { "id": 1024 } } ```

GPT中文 也可能出错,成品请自己核对关键数字和事实。条款 · 隐私