API 文档生成
分析代码生成 API 文档 → 验证完整性 → 输出最终文档
👁 0
- 类型
- 团队模板
- 标识
- ao-wf-017
- 作者
- Agency Orchestrator · jnMetaCode ↗
- 来源链接
- 点击查看 ↗
- 来源类型
- github
- 许可
- Apache-2.0
- 地区
- cn / global
- 上架日期
- 2026-11-08
- 成员
- 2 人
- 内含技能
- 0 个
添加到 MengBot已装客户端时直接打开;否则先安装 MengBot
提示词
来自模板包,可直接复制技术文档工程师
请分析以下 API 代码,生成完整的 API 文档:
## API 代码
{{api_code}}
## 上下文信息
{{api_context}}
请按以下结构生成文档:
### 对每个 API 端点,请提供:
1. **接口路径**:HTTP 方法 + URL
2. **功能描述**:简洁说明接口用途
3. **请求参数**:
- Path 参数(类型、是否必填、说明)
- Query 参数(类型、是否必填、默认值、说明)
- Body 参数(完整的 JSON Schema,含嵌套结构)
4. **请求头**:需要的认证头和自定义头
5. **响应格式**:
- 成功响应(状态码 + 示例 JSON)
- 错误响应(各错误状态码 + 示例)
6. **调用示例**:cURL 命令示例
文档风格要求:清晰、准确、面向开发者。API 测试员
请审查以下 API 文档的完整性和准确性:
## API 文档草稿
{{api_doc_draft}}
## 原始 API 代码(供对照)
{{api_code}}
请检查以下方面:
1. **完整性**:是否所有端点都已记录、是否有遗漏的参数或响应字段
2. **准确性**:参数类型是否正确、必填/选填标注是否与代码一致
3. **示例有效性**:请求和响应示例是否合法、是否能实际运行
4. **错误处理**:是否记录了常见错误状态码和错误消息格式
5. **一致性**:命名风格、描述格式是否全文一致
请输出:
- 发现的问题清单(按严重程度排序)
- 每个问题的具体修改建议技术文档工程师
请根据审查反馈,修正并输出最终版 API 文档:
## 文档草稿
{{api_doc_draft}}
## 审查反馈
{{validation_report}}
请:
1. 逐条修复审查中指出的所有问题
2. 确保文档格式统一、排版美观
3. 在文档开头添加概览部分(API 列表、认证说明、通用错误码)
4. 在文档末尾添加更新日志模板
输出完整的、可直接使用的 API 文档。技术文档工程师
请分析以下 API 代码,生成完整的 API 文档:
## API 代码
{{api_code}}
## 上下文信息
{{api_context}}
请按以下结构生成文档:
### 对每个 API 端点,请提供:
1. **接口路径**:HTTP 方法 + URL
2. **功能描述**:简洁说明接口用途
3. **请求参数**:
- Path 参数(类型、是否必填、说明)
- Query 参数(类型、是否必填、默认值、说明)
- Body 参数(完整的 JSON Schema,含嵌套结构)
4. **请求头**:需要的认证头和自定义头
5. **响应格式**:
- 成功响应(状态码 + 示例 JSON)
- 错误响应(各错误状态码 + 示例)
6. **调用示例**:cURL 命令示例
文档风格要求:清晰、准确、面向开发者。
API 测试员
请审查以下 API 文档的完整性和准确性:
## API 文档草稿
{{api_doc_draft}}
## 原始 API 代码(供对照)
{{api_code}}
请检查以下方面:
1. **完整性**:是否所有端点都已记录、是否有遗漏的参数或响应字段
2. **准确性**:参数类型是否正确、必填/选填标注是否与代码一致
3. **示例有效性**:请求和响应示例是否合法、是否能实际运行
4. **错误处理**:是否记录了常见错误状态码和错误消息格式
5. **一致性**:命名风格、描述格式是否全文一致
请输出:
- 发现的问题清单(按严重程度排序)
- 每个问题的具体修改建议
技术文档工程师
请根据审查反馈,修正并输出最终版 API 文档:
## 文档草稿
{{api_doc_draft}}
## 审查反馈
{{validation_report}}
请:
1. 逐条修复审查中指出的所有问题
2. 确保文档格式统一、排版美观
3. 在文档开头添加概览部分(API 列表、认证说明、通用错误码)
4. 在文档末尾添加更新日志模板
输出完整的、可直接使用的 API 文档。在 MengBot 客户端内安装
本站只展示摘要与许可信息。安装包、连接配置与工具白名单由客户端经鉴权获取,不在网页上公开。