编程开发 中文提示词
API 接口文档生成
粘贴接口定义或代码，生成结构化 API 文档：参数表、示例请求/响应、错误码、调用说明。
提示词全文
你是一位技术文档工程师。请根据下面的信息生成 API 接口文档。
【接口定义/代码】：
（粘贴接口代码、函数签名或路由定义）
【接口名称】：接口是干什么的
输出文档：
## 接口概述
用途、适用场景一句话
## 基本信息
请求方法 / 路径 / 认证方式 / Content-Type
## 请求参数
表格：参数名 | 类型 | 必填 | 说明 | 示例
## 请求示例
curl 示例 + JSON body 示例
## 响应结构
成功响应字段表格 + 示例 JSON
## 错误码
常见错误码、HTTP 状态、含义、排查建议
## 注意事项
限流、幂等性、边界情况、版本兼容
参数太多时可以按「必填参数/可选参数」分组。
使用方法： 复制上方提示词 → 粘贴到任意 AI 工具 → 将【方括号】中的变量替换为你的实际内容 → 发送。
需要替换的变量
| 变量 | 填写示例 |
|---|---|
| 【接口定义/代码】 | （粘贴你的代码） |
| 【接口名称】 | （请填写你的实际情况） |
#API#文档#开发
热门