答案是:需严格按OpenAPI 3.0.3、Postman Collection v2.1、TypeScript 5.4规范分别生成三套接口定义,确保字段命名、类型、必填性、变量语法及格式约束完全匹配真实接口与工具链要求。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

你需要为同一组API接口字段生成Swagger风格、Postman Collection风格、TypeScript Interface风格三套示例,但直接让Codeium“生成接口示例”会混用缩进规则、错标必填项、漏掉类型映射——比如把string写成String,把required: true写成optional: false,导致前端开发时TS编译报错、Postman导入后字段丢失。
Swagger 3.0 YAML风格示例
第一步:在提示词开头声明目标格式与版本
你正在生成符合OpenAPI 3.0.3规范的YAML格式接口定义,所有字段必须严格遵循swagger.io官方schema校验规则。
第二步:注入字段原始数据(必须保留原始命名与语义)
复制真实接口返回JSON片段(如{"user_id":123,"is_active":true,"created_at":"2024-05-12T08:30:00Z"}),粘贴到提示词中,并标注【原始响应体】。
第三步:绑定Swagger特有约束
required字段必须从原始JSON中提取键名列表,显式写入required: [user_id, is_active];字符串时间戳字段created_at必须标注format: date-time;布尔字段is_active必须加type: boolean且不加引号——【若写成is_active: "true"或type: bool,Swagger UI将无法正确渲染开关控件】。
Postman Collection v2.1 JSON风格示例
方法一:结构锚定法
在提示词中明确写出Postman Collection根结构特征:“输出必须为标准Postman Collection v2.1 JSON对象,顶层含info、item两个键;每个item必须是request对象,含method、header、body三个子键;body必须为raw类型且contentType为application/json。”
方法二:字段映射法
对原始字段做Postman专用转换:user_id → 在body raw中写为"user_id": {{user_id}}(使用双大括号变量语法);is_active → 转为"user_status": "{{status}}"并注明status变量默认值为"active";created_at → 替换为"timestamp": "{{iso_timestamp}}"并说明iso_timestamp由Postman内置变量pm.variables.replaceIn()生成。
这一步操作起来很简单,直接把{{}}变量写进body raw就行,不要用$env或$collectionVariables——【Postman v10+已弃用$符号语法,混用会导致预请求脚本失效】。
TypeScript Interface风格示例
① 先声明环境约束
你正在为TypeScript 5.4项目生成接口类型定义,依赖@types/node 20.14,禁止使用any、never、unknown,所有可选字段必须用?修饰符。
② 再执行字段类型推导
user_id → number(非string,因原始JSON中为纯数字);is_active → boolean(不是Boolean类);created_at → string(不转为Date,因API返回的是ISO字符串);新增@deprecated注释标记已下线字段(如old_token)。
③ 最后强制输出格式
输出必须为单个interface声明,名称按CamelCase命名(如UserResponse),不含export关键字,不带JSDoc以外的注释,每行结尾不加分号——【分号会导致ESLint @typescript-eslint/no-extra-semi 报错】。

















