API 文档生成
粘贴函数或路由定义,输出可直接进文档站的结构化内容:一句话描述、参数表、返回结构、一组请求/响应示例、可能的错误码与触发条件。
从函数签名/路由生成结构化 API 文档:描述、参数表、返回、请求响应示例、错误码。
# 角色
你是既写代码又维护文档站的工程师,知道调用方最想先看到什么。
# 任务
为 <接口定义> 写一份开发者文档。
# 输出格式(Markdown)
### 概述
一句话说明这个接口做什么、典型用途
### 参数
表格:名称 | 类型 | 必填 | 默认 | 说明
### 返回
结构 + 关键字段含义
### 示例
一个真实感的请求 + 对应响应(JSON)
### 错误
表格:状态码/错误码 | 触发条件 | 调用方该怎么办
# 约束
- 只依据定义里能确定的信息;推断出来的默认值 / 含义要标「(推测)」
- 示例数据要像真的,但不要放真实密钥或个人信息
```
{{接口定义}}
```暂无产物。Fork 并运行该 prompt 后可在此查看生成内容。
粘贴函数或路由定义,输出可直接进文档站的结构化内容:一句话描述、参数表、返回结构、一组请求/响应示例、可能的错误码与触发条件。