<p>【你是一位有3年API治理经验的后端文档工程师,正在为生产环境v2.3版本编写OpenAPI 3.0文档】;禁止将响应字段名替换成驼峰以外的格式;禁止省略字段是否必填;禁止用“类似”“例如”描述枚举值。json{"code": 0, "msg": "ok", "data": {"id": 123, "status": "pending", "tags": ["urgent", "review"]}}【注意】status字段仅允许"pending"/"approved"/"rejected"三值;tags数组长度上限为3,元素不可重复。id → 必填,类型number,范围≥1且≤999999999;status → 必填,枚举值["pending","approved","rejected"],缺失时返回400;tags → 非必填,类型array,每个元素为string,最大长度16字符。status字段若出现"processing"值,【后端将直接拒绝该请求并返回HTTP 400】;tags数组若含空字符串或null元素,【整条记录会被丢弃且不报错】。</p>
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要让Codeium生成的接口文档能被前端直接对照着写调用代码,但当前输出里字段名和实际API返回不一致、必填项没标清楚、枚举值只写“status: string”却不列具体取值——这会导致联调反复返工。
强制绑定真实响应结构
在提示词开头第一行写:【你是一位有3年API治理经验的后端文档工程师,正在为生产环境v2.3版本编写OpenAPI 3.0文档】。
紧接着用分号隔开三项禁令:禁止将响应字段名替换成驼峰以外的格式(如把user_name改成userName);禁止省略字段是否必填,默认所有字段都需显式标注required: true/false;禁止用“类似”“例如”描述枚举值,必须穷举全部合法取值。
粘贴真实HTTP响应体片段(至少5行),并用【注意】标注关键字段约束:
```json
{"code": 0, "msg": "ok", "data": {"id": 123, "status": "pending", "tags": ["urgent", "review"]}}
```
【注意】status字段仅允许"pending"/"approved"/"rejected"三值;tags数组长度上限为3,元素不可重复。
字段级校验规则嵌入提示词
方法一:用「字段名 → 校验动作」句式逐条锁定
id → 必填,类型number,范围≥1且≤999999999;
status → 必填,枚举值["pending","approved","rejected"],缺失时返回400;
tags → 非必填,类型array,每个元素为string,最大长度16字符。
方法二:对易错字段追加后果说明
status字段若出现"processing"值,【后端将直接拒绝该请求并返回HTTP 400】;
tags数组若含空字符串或null元素,【整条记录会被丢弃且不报错】。
按OpenAPI规范生成可执行定义
第一步:要求输出必须包含components/schemas下的完整schema定义,字段顺序与真实响应严格一致。
第二步:每个字段下必须嵌套以下三项:
① type(精确到string/integer/boolean/array/object);
② required(布尔值,不写默认false);
③ enum(仅当字段为枚举时存在,否则禁止出现该字段)。
第三步:在schema末尾添加x-codeium-verify注释,内容为可执行验证SQL或curl命令:
"x-codeium-verify": "curl -s 'https://api.example.com/v2/orders?limit=1' | jq '.data[0].status' | grep -E '^(pending|approved|rejected)$'"

















