适用问题:如何通过结构化提示词生成规范、清晰的GPT接口文档?
准备资料:需要提供接口定义、调用示例、响应格式等基础信息。
具体步骤:1. 明确接口类型(REST API/GraphQL等);2. 列出接口方法(GET/POST/PUT/DELETE)及参数;3. 定义请求格式(JSON/XML)和响应格式;4. 添加错误处理机制;5. 指定文档输出格式(如Markdown、JSON Schema等)。
虚构示例:
原始输入:"定义一个获取用户信息的接口,GET方法,参数为user_id,返回用户数据"。
完整提示词:"请根据以下信息生成接口文档:接口类型为REST API,方法为GET,参数为user_id,返回类型为JSON,要求包含用户ID、姓名、邮箱字段,错误处理需返回HTTP状态码404和400"。
示例输出:
接口文档:GET /users/123
请求参数:user_id=123
响应格式:{"id": "123", "name": "张三", "email": "[email protected]"}
错误处理:404 Not Found,400 Bad Request。
核对清单:
1. 接口类型是否明确?
2. 方法是否为GET?
3. 参数是否包含user_id?
4. 返回格式是否为JSON?
5. 是否包含用户ID、姓名、邮箱字段?
6. 是否有错误处理机制?
7. 文档输出格式是否指定?
8. 示例输出是否与提示词一致?
9. 是否涵盖所有必要字段?
10. 是否有清晰的接口说明?
常见误区:
1. 未明确接口类型导致文档混乱;
2. 参数未指定导致调用困难;
3. 响应格式未定义导致无法验证数据;
4. 缺乏错误处理机制影响用户体验;
5. 文档输出格式未指定导致格式不统一。
案例任务:根据用户提供的接口定义,生成结构化提示词,并输出符合规范的接口文档。