REST Client插件需用.http后缀、首行合法HTTP格式、正确配置环境变量;Swagger插件生成TS类型时注意命名冲突与operationId更新;代码片段需精准占位符和前缀;Java生成方法需右键正确包路径并手动调整命名。

用 REST Client 插件写 .http 文件直接发请求
REST Client 是最轻量、最贴近 HTTP 原语的方案,不依赖项目结构,适合调试、联调、临时验证。它不生成代码,但能快速跑通接口逻辑,避免写一堆 axios 或 fetch 胶水代码。
常见错误现象:Send Request 按钮不出现、返回 404 或 ERR_CONNECTION_REFUSED。
- 确保文件后缀是
.http(不是.txt或.md) - 首行必须是合法 HTTP 方法 + URL + 协议版本,例如:
GET https://api.example.com/users HTTP/1.1 - 如果用了环境变量,
settings.json中的rest-client.environmentVariables必须配置正确,且当前激活环境名要匹配(比如"@dev") - 带请求头时,空行不能少:方法行之后必须换行,再写
Content-Type: application/json等,最后再空一行才写 body
用 Swagger Doc To Code 自动生成 TypeScript 接口类型
当你已有 OpenAPI 3.0 / Swagger v2 文档(swagger.json 或 openapi.yaml),这个插件能一键生成带类型定义的请求函数,比手写 useQuery 或 apiClient.getUsers() 更可靠。
容易踩的坑:
- 插件默认生成的命名空间可能和你项目已有类型冲突,务必勾选
Enable namespace isolation - 中文路径或接口标题会被转成英文,但分词不准(比如“用户管理”→
UserGuangLi),建议提前在文档里用x-group或tags标注规范分组名 - 增量更新只比对 operationId,如果改了接口但没改
operationId,旧类型不会被覆盖——得手动删或清空目标目录再重生成
用用户代码片段(Snippets)快捷插入 axios/fetch 请求骨架
适合 Vue/React 项目中高频手写请求逻辑的场景,比如每次都要写 this.$http.adornUrl('') 或 axios.create({ baseURL }) 配置。
关键点在于:body 中的占位符和转义要准确。
-
prefix别用太泛的词(如req),容易和其他片段冲突;推荐用axget、axpost这类明确前缀 - Vue 项目若用
this.$http封装,注意adornParams和adornData的参数顺序:get 用params,post 默认用data,且adornData(data, false)第二个参数决定是否序列化为 form-data - TS 项目中,body 里别硬写
any,应留出$1让你补类型,例如:const res = await api.getUser(id); - 保存后必须重启编辑器或重新打开对应语言文件,否则新片段不生效
Java 类中自动生成 API 调用方法(靠 Java Class Generator)
不是生成模板,而是直接在 service 层类里插入完整方法体,含参数校验、异常包装、返回值封装——适合 Spring Boot 项目统一风格开发。
限制很明确:它只生成方法签名和空实现,不处理 URL 拼接或 DTO 映射。
- 右键必须点进真实存在的包路径(如
src/main/java/com/example/api),不能点src或空文件夹,否则类会建错位置 - 生成的方法名默认驼峰,但接口路径含下划线(如
/user_info)时,得手动改方法名,不然不符合 Java 命名习惯 - 如果项目用 Lombok,记得在生成后补
@Slf4j或@RequiredArgsConstructor,插件不自动加
adornUrl 是特定框架封装,换个项目就得重配 snippet;又比如 Swagger 生成的 type 名带 InlineResponse200,没人愿意在业务代码里写这种名字——这些细节不提前对齐,模板越快,后续改得越疼。


















