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

写接口文档给前端看

关于「写接口文档给前端看」：能拿到什么、要点选什么、怎么办

传接口代码，5分钟拿到带示例的接口文档。为前端工程师生成可读性强、含请求示例和响应示例的接口文档；不提供代码实现、不替代联调，最终由前后端共同确认。

能拿到什么

  • 推荐：排好版的接口文档 Word/PDF，含参数表、请求响应示例、错误码和待确认项标注（每个接口一页，参数用表格，示例代码带高亮，待确认项标黄），约 5 分钟
  • 旗舰：接口文档 Word/PDF、接口清单 Excel、待确认项清单、变更记录

要你点选的几项

写给谁看、什么场合用、上传接口代码或描述、要写进哪些内容、口吻、篇幅、具体情况、格式要求、要不要备注。多数点一下就行，没选的按常见情况替你定，交付时说清哪几项是按默认的。

怎么办

  1. 上传接口代码或描述
  2. 选写给谁看和要写的内容
  3. 生成带示例的接口文档
  4. 下载发给前端

别人还这样说

  • 帮我把这段Spring Boot接口转成前端能看懂的文档
  • 这个Go接口要给Vue组用，加个调用示例吧
直接说你要办的事。下面是别人怎么办的，点任何一项就换成你自己的。左边是别人怎么办的，右边是你的，点一项就开始改。
示范 · 别人这样说

「根据这个JSON返回结构，生成一份给前端看的接口说明文档。」

替他选了：Vue前端 · 日常迭代交接 · 请求URL和方法、成功响应结构、真实响应示例 · 简洁技术风 · 单接口一页 · GitHub风格Markdown

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

你的成品会在这里出现
示例成品 · 不是你的按示范写的，看个样子
# 用户登录接口 **URL**：`POST /api/v1/login` **请求体（JSON）**： ```json {"phone": "13800138000", "code": "123456"} ``` **成功响应（200）**： ```json {"token": "eyJhbGciOi...", "user_id": 1024} ``` **错误响应（400）**： ```json {"error": "验证码错误"} ```

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