需将后端OpenAPI 3.0 YAML/JSON文件保存为openapi.yaml,通过Codex插件生成React+TS接口代码:自动创建api.ts、types.ts、index.ts,支持鉴权与类型对齐,调用时若TS报错需修正定义文件。
☞☞☞AI 智能聊天, 问答助手, AI 智能搜索, 多模态理解力帮你轻松跨越从0到1的创作门槛☜☜☜

准备接口定义文件
把后端提供的 OpenAPI 3.0 YAML 或 JSON 文件保存到本地项目根目录下,命名为 【openapi.yaml】。不能用 Swagger UI 页面截图或 Word 文档代替,Codex 只能解析结构化接口描述。
如果只有 Postman Collection,先导出为 OpenAPI 格式:在 Postman 中打开集合 → ⋯ → Export → Export as → OpenAPI 3.0 YAML → 保存。
在 Codex 中加载上下文并触发生成
打开 VS Code,确保已安装 Codex 插件并完成登录;右键点击 openapi.yaml 文件 → 选择 “Codex: Generate from OpenAPI”。
若该菜单项不可见,说明插件未识别到有效 OpenAPI 文件——检查文件首行是否为 openapi: 3.0.0 或更高版本,且无语法错误(可用在线 YAML 验证器校验)。
立即学习“前端免费学习笔记(深入)”;
生成过程会自动读取当前项目中的 tsconfig.json、package.json 和已有 API 工具库(如 axios 实例路径、request interceptor 定义),确保生成的代码风格与项目一致。
选择生成目标与配置参数
出现参数面板后,按需设置:
配置 OpenClaw 多提供商认证与 OpenAI Codex OAuth 备用方案,实现自动模型切换,适用于多 OpenAI Codex 账户设置。
- Target Framework:选 React + TypeScript(若项目用 Vue,则选 Vue 3 Composition API)
-
Request Library:默认 axios,若项目已封装
apiClient,点“Custom”填入其导入路径,例如src/utils/apiClient.ts -
Output Directory:建议填
src/services/generated,避免覆盖手写服务层
勾选 “Generate TypeScript types only” 可跳过请求函数,仅生成接口类型定义——适合你只想补全 types.ts 的场景。
执行生成并验证调用链路
点击 “Generate” 后等待 3~8 秒,Codex 自动创建以下内容:
① src/services/generated/api.ts:含所有接口的封装函数,每个函数返回 Promise,自动注入鉴权 header;
② src/services/generated/types.ts:基于 components.schemas 生成的完整类型,字段名与后端完全对齐;
③ src/services/generated/index.ts:统一导出,支持解构导入,例如 import { useGetUserList } from '@/services/generated'。
立即在任意组件中尝试调用:const { data } = await api.getUserList({ page: 1, size: 10 }); —— 若 TS 提示类型错误,说明 openapi.yaml 中某处 required 字段声明与实际响应不符,需回溯修正定义文件。














