适用问题:如何用中文提示词生成清晰规范的GPT接口文档?
准备资料:需收集接口定义、请求参数、响应格式、错误码等信息,确保文档内容完整。
具体步骤:1. 明确接口功能与用途;2. 列出请求方法、路径、参数;3. 规范响应结构与状态码;4. 添加注释说明使用场景。
虚构示例:
原始输入:"请生成一个包含接口定义、请求参数、响应格式和错误码的中文接口文档。"
完整提示词:"请生成一个包含接口定义、请求参数、响应格式和错误码的中文接口文档,要求结构清晰,格式规范,注释明确。"
示例输出:
接口名称:user_auth
请求方法:POST
路径:/api/v1/auth
参数:username(必填)、password(必填)
响应格式:JSON,包含status、message、data字段
错误码:400-无效凭证,401-未授权,500-服务器错误。
核对清单:
- 接口名称是否准确?
- 请求参数是否完整?
- 响应格式是否规范?
- 错误码是否对应?
- 是否有注释说明?
常见误区:忽略接口用途说明,导致文档缺乏上下文;参数未分类型,造成使用困惑;响应格式不统一,影响调试效率。