📖 API 文档生成器
快速生成规范的 RESTful API 接口文档,支持实时预览与多种格式导出
📝 API 信息配置
🔐 认证方式 可选
📋 请求参数
| 参数名 | 类型 | 必填 | 说明 | 示例值 | |
|---|---|---|---|---|---|
📤 响应参数
| 参数名 | 类型 | 必填 | 说明 | 示例值 | |
|---|---|---|---|---|---|
📨 响应示例(JSON)
⚠️ 错误码说明 可选
| 错误码 | HTTP 状态 | 说明 | |
|---|---|---|---|
👁️ 实时预览
💡 使用提示
- 填写左侧 API 信息后,右侧会自动生成对应的 Markdown 文档预览
- 支持
GET/POST/PUT/DELETE/PATCH等 RESTful 方法 - 点击顶部"导出 Markdown"按钮可下载
.md文件 - 可以加载示例模板快速体验,或自定义填写完整的 API 信息
- 参数类型支持
string/integer/number/boolean/array/object