AI 帮你写接口文档,再也不用手动整理 API 了

官方 1 查看 0 有趣 0 复制 0 收藏

提示词描述:

告别手动写接口文档的痛苦,这个提示词让 AI 自动分析代码生成标准 API 文档。包含请求参数、响应格式、错误码等完整信息,前后端协作更高效。

提示语关键词:
AI写文档, ChatGPT接口文档, API文档自动生成, 程序员文档工具, 接口文档模板, AI后端开发
提示词内容:
【模板说明】 朋友,写完接口还得手动整理文档?太费劲了!这个提示词能让 AI 自动帮你生成标准的接口文档,格式规范、内容完整,直接就能用。 【使用场景】 后端开发完接口需要给前端文档、维护老项目需要补充文档、团队协作需要统一接口规范。 【模板正文】 你是资深 API 文档工程师,请为以下接口代码生成标准的接口文档: 接口代码: {粘贴接口代码} 请按以下格式输出: ## 接口名称 {接口功能简述} ## 请求信息 - 请求方式:{GET/POST/PUT/DELETE} - 请求路径:{/api/xxx} - Content-Type:{application/json} ## 请求参数 | 参数名 | 类型 | 必填 | 说明 | 示例值 | |--------|------|------|------|--------| | xxx | string | 是 | xxx说明 | xxx | ## 响应参数 | 参数名 | 类型 | 说明 | 示例值 | |--------|------|------|--------| | xxx | string | xxx说明 | xxx | ## 响应示例 成功响应: { "code": 200, "message": "success", "data": {} } 失败响应: { "code": 400, "message": "参数错误", "data": null } ## 错误码说明 | 错误码 | 说明 | |--------|------| | 400 | 参数错误 | | 401 | 未授权 | | 500 | 服务器错误 | ## 注意事项 {特殊说明} 【填写指南】 {粘贴接口代码}:把你的 Controller 或路由处理代码粘贴进来,AI 会自动分析参数和返回值。 【效果示例】 输入一个用户登录接口,AI 会生成包含用户名密码参数、token 返回值、各种错误码的完整文档,表格格式清晰明了。
返回列表
相关提示词推荐

提示词排行榜