适用问题:如何通过GPT生成结构化接口文档表格?
准备资料:需提供接口信息、功能描述、参数说明、返回值等文本内容。
具体步骤:
1. 明确输出格式,如表格字段包括接口名称、请求方法、请求参数、响应示例等。
2. 提供清晰的输入文本,确保字段信息完整。
3. 使用提示词引导模型生成表格,如"请以表格形式输出接口文档,包含接口名称、请求方法、参数说明、响应示例等字段"。
虚构示例:
原始输入:
接口名称:用户登录
请求方法:POST
参数说明:username(字符串)、password(字符串)
响应示例:{"code": 200, "message": "成功"}
完整提示词:"请以表格形式输出接口文档,包含接口名称、请求方法、参数说明、响应示例等字段"。
示例输出:
| 接口名称 | 请求方法 | 参数说明 | 响应示例 |
|----------|----------|----------|----------|
| 用户登录 | POST | username(字符串)、password(字符串) | {"code": 200, "message": "成功"} |
核对清单:
1. 是否包含接口名称、请求方法、参数说明、响应示例字段?
2. 表格格式是否清晰?
3. 输出内容是否与原始输入一致?
4. 是否包含必要的字段信息?
5. 表格是否简洁易读?
6. 输出是否符合用户预期?
7. 是否遗漏关键字段?
8. 表格结构是否合理?
9. 输出内容是否准确无误?
10. 是否符合接口文档规范?
常见误区:
1. 未明确输出格式,导致表格结构混乱。
2. 参数说明不清晰,影响理解。
3. 响应示例不完整,导致信息缺失。
4. 未按字段顺序排列,影响可读性。
5. 未验证原始输入是否完整,导致输出错误。
6. 未检查表格格式是否符合规范,影响专业性。