适用问题:如何生成结构化、可读性强的GPT接口文档?
准备资料:需包含接口定义、请求参数、响应格式、错误码等信息。
具体步骤:1. 明确接口功能与用途;2. 列出请求方法、路径、参数;3. 定义响应格式与状态码;4. 添加注释与说明;5. 生成文档并检查一致性。
虚构示例:
原始输入:"请生成一个包含接口名称、请求方法、参数说明、响应格式的接口文档。"
完整提示词:"请生成一个结构清晰、格式规范的GPT接口文档,包含接口名称、请求方法、参数说明、响应格式、状态码及注释。请确保内容准确且符合编程规范。"
示例输出:
接口名称:user_register
请求方法:POST
参数说明:username(字符串,必填)、password(字符串,必填)、email(字符串,必填)
响应格式:JSON,包含status(整数)、message(字符串)、data(对象)
核对清单:
1. 接口名称是否准确?
2. 请求方法是否正确?
3. 参数说明是否完整?
4. 响应格式是否规范?
5. 是否包含状态码与注释?
6. 内容是否符合编程标准?
7. 文档结构是否清晰?
8. 是否覆盖所有必要信息?
9. 是否有错别字或语法错误?
10. 是否符合用户使用场景?
常见误区:忽略状态码与错误处理;参数说明不明确;响应格式不统一;文档结构混乱;未考虑用户实际使用场景。