ChatGPT生成API文档易空泛,需用三栏表格模板(字段名/类型/说明),说明栏必须含真实JSON样例和明确约束,并绑定业务场景与错误码逻辑,禁用模糊表述,辅以正反示例对比。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

ChatGPT在生成API接口文档时,常把返回示例直接写成字段说明,导致内容空泛、缺乏上下文和边界信息,比如只写“user_id:用户唯一标识”,却不说明类型、是否必填、取值范围或实际样例值。
用结构化模板约束输出格式
第一步:在提示词开头明确要求使用「三栏表格」格式,列名为【字段名】【类型】【说明(含样例值+约束条件)】。
第二步:在说明栏强制加入两个硬性要素:①真实可运行的JSON样例片段(如"status": 200),②显式标注必填/可选、长度限制或枚举值(如“仅限'active'、'inactive'”)。
第三步:追加一句否定指令:“禁止出现‘表示’‘用于’‘标识’等空泛动词短语;所有说明必须能直接替换进测试用例断言。”
注入具体业务上下文锚点
方法一:把接口调用场景写成前置条件句。例如:“当用户提交订单且支付成功后,/v1/orders/{id} 返回订单详情——此时需重点说明payment_time字段在‘未支付’‘已退款’‘分账中’三种状态下的取值逻辑。”
方法二:绑定真实错误码与字段联动关系。例如:“若返回code=400,则detail字段必含reason字段,其值为字符串且长度≤200;此时user_id字段不出现。”
用于在用户想通过浏览器自动化与 Google Gemini 或 ChatGPT 交互时。触发短语包括“ask Gemini”“ask ChatGPT”“ask GPT”“让...”。
【不写‘可能包含’‘通常为’这类模糊表述,只写‘必含’‘不出现’‘恒为null’】
用对比样本引导模型识别空洞表达
在提示词末尾附一段对比示例:
✘ 空洞写法:“name:用户姓名”
✔ 具体写法:“name:字符串,长度2–30,仅含中文、英文字母、空格及·(中间点);样例值:"张三·Lee";当用户未设置昵称时返回null”
这一步操作起来很简单,直接把对比样本粘贴在提示词最后即可生效。

















