gemini生成接口文档需明确字段元信息:第一步声明json schema结构约束;第二步description用方括号标注实质约束;第三步禁用模糊词并列全枚举值;再用分隔符或http动词逻辑区分请求/响应字段;最后插入真实json样例反推含义,杜绝虚构。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

用Gemini生成接口文档时字段解释模糊、缺失必填标识、类型描述笼统,导致开发人员反复确认,浪费联调时间。
明确字段元信息的提示词写法
第一步:在提示词开头直接声明输出结构约束,禁止自由发挥。例如:“请严格按以下JSON Schema输出字段说明,每个字段必须包含name、type、required、description四个键,不得增删或改名。”
第二步:为description字段加语义锚点。不要写“该字段表示用户ID”,而要写“【用户唯一标识符,由后端UUID生成,前端不可修改】”。【必须用方括号包裹实质约束,否则Gemini会忽略】
第三步:显式禁用模糊词汇。在提示词末尾追加:“禁用‘可能’‘一般’‘通常’‘相关’等不确定表述;若字段有枚举值,必须完整列出并标注code和中文含义。”
强制区分请求/响应字段的提示策略
方法一:用分隔符物理隔离。在提示词中插入清晰标记:=== REQUEST FIELDS === 和 === RESPONSE FIELDS ===,并分别说明各自字段需体现的上下文特征(如“request字段需标注是否参与签名计算”)。
方法二:绑定HTTP动词逻辑。要求Gemini根据method字段自动推导字段流向:“当method为POST时,所有type为string且name含‘token’的字段,description必须注明‘由/auth/login接口返回,有效期2小时’。”
让Gemini不编造默认值的关键技巧
在提示词中插入真实样例片段,而非抽象描述。例如粘贴一段真实请求体:{"user_id":"usr_9a8b7c","status":1,"updated_at":"2024-05-22T08:30:45Z"},然后指令:“以上字段的description须基于此实例反推业务含义,未出现的字段不得虚构默认值或示例。”
这一步操作起来很简单,直接把抓包得到的原始JSON粘进去就行。但要注意:样例必须带真实字段名和典型值,不能替换为占位符如{user_id},否则Gemini会当成模板继续编造。











