API 接口文档自动生成器(免费版)
输入字段
| 字段 | 必填 | 说明 |
|---|---|---|
| 接口路径 | 是 | 如 /api/clients |
| HTTP方法 | 是 | GET/POST/PUT/DELETE |
| 功能描述 | 是 | 一句话说明 |
| 请求参数/响应 | 否 | 有则填,无则标注"待补充" |
工作流
- 解析路径+方法+描述,生成文档头(标题/用途/基础URL)
- 生成请求段:参数表(名/类型/必填/说明)与请求示例
- 生成响应段:成功/失败示例 + 错误码表(4xx/5xx)
- 输出 Markdown 文档骨架,未提供的字段标"待补充"不编造
硬性规则
- 不编造接口参数/返回字段:未提供的一律标"待补充"
- 错误码只列通用HTTP语义,不虚构业务错误码
示例
输入:POST /api/clients 新增客户
输出:文档头 + 请求参数表(requestBody: name/cellphone必填) + 201成功/400失败响应 + 错误码表