VSCode插件快速生成各类常用API代码-VSCode-PHP中文网

vscode本身不生成api代码，仅转译注释、配置或运行时接口为可读格式；真正生成代码依赖运行时库（如fastapi、springdoc-openapi）或cli工具（如openapi generator），插件仅作管道或预览器。

vscode插件快速生成各类常用api代码

VSCode 本身不生成 API 代码，它只帮你把已有注释、配置或运行时暴露的接口“转成可读格式”或“补全模板”。真正能产出可用 API 代码的，是语言生态里的运行时库（如 FastAPI、springdoc-openapi）或 CLI 工具（如 OpenAPI Generator），VSCode 插件只是管道或预览器。

为什么你点“Generate API”没反应？

常见错误现象：Command 'OpenAPI: Generate' not found 或右键菜单压根没有该选项——这说明你装的插件不匹配当前文件类型，或没打开合法的 OpenAPI 文件。

插件不会主动扫描整个项目去“猜”接口；它只响应特定上下文：比如打开 openapi.yaml 且文件开头含 openapi: 3.0.3，或在 Spring Boot 项目中已启动服务并暴露了 /v3/api-docs 接口
JavaScript/TypeScript 项目用 swagger-jsdoc 时，必须提前在代码里写好 definition 对象和 apis 路径数组，VSCode 插件不执行 JS，只做静态扫描
FastAPI 项目虽自带 /docs 页面，但 VSCode 插件不会自动调用该路由；它需要你手动配置代理或使用 OpenAPI Generator CLI 拉取 JSON

真正能干活的组合：OpenAPI Generator CLI + vscode-openapi

这是目前最可控、语言支持最广的“从文档生成代码”路径。VSCode 不直接生成，但可以一键调用 CLI。

VSCode

避免常见的 VSCode 错误——设置冲突、调试器配置和扩展冲突。

下载

先确保本地已安装 openapi-generator-cli：npm install -g @openapitools/openapi-generator-cli
在 VSCode 中安装 vscode-openapi 插件（注意不是名字带 Swagger 却只做高亮的那个）
右键点击合法的 openapi.yaml → 选择 OpenAPI: Generate Client → 选语言（如 typescript-axios 或 java）→ 指定输出目录
生成结果不含业务逻辑，只有接口定义、DTO 和请求封装；你要把它 import 进项目，再配合自己的 service 层使用

Vue/React 前端调用 API 的快捷补全怎么来？

前端开发者常误以为“API 代码生成”是指 uni.request 或 axios.get('/user') 这类调用，其实这类补全靠的是类型系统 + snippets 联动，不是“生成”。

装 Vue VSCode Snippets 后，输入 vapi 并 Tab 可展开一个带 onMounted + axios.get 的模板，但它不校验 URL 是否真实存在
要让 uni.showToast 参数被提示、count 最大值为 9 被捕获，必须装 @uni-helper/uni-app-types 并在 tsconfig.json 的 compilerOptions.types 中声明
React 用户若用 swr 或 react-query，建议搭配 openapi-typescript-codegen CLI 生成 hooks，再用 VSCode 的 TS 类型推导自动补全返回值

别忽略 $ref 和本地路径的坑

很多团队写的 openapi.yaml 会用 $ref: ./schemas/user.yaml 拆分结构，但 VSCode 插件默认不解析相对路径引用。

Swagger Viewer 插件预览时，若看到 Reference could not be resolved，大概率是 $ref 指向了未打开的文件，或路径用了 Windows 风格反斜杠 \
解决办法：统一用正斜杠 /，所有被引用的 YAML 文件必须和主文件在同一工作区根目录下，或用 openapi-validator CLI 先合并成单文件再预览
更稳妥的做法是，在 CI 流程里用 openapi-cli bundle 把所有 $ref 内联，再交给 VSCode 插件处理