工作助手 (Work Assistant)

概述

工作助手是一个基于 Swagger 的 VS Code 扩展，帮助你管理接口项目、快速搜索请求、查看接口详情

核心功能

• 添加 Swagger 项目并保存到全局状态
• 在“工作助手”侧边栏中查看项目及其接口
• 搜索接口路径、HTTP 方法，快速定位所需 API
• 修改项目标题、刷新接口列表
• 打开接口详情面板，查看请求/响应示例，请求/响应mock数据

解决网页Swagger的痛点问题

1. 需要切换到浏览器查看请求地址
2. Swagger网页需要添加到保活状态，否则过一会进去会重新加载
3. 想找入参字段，需要经历 点击Schema，然后一个一个字段展开，查看入参描述，才能知道是什么意思
4. Swagger地址太多，没有统一管理的地方

优点

1. 直观
2. 快捷
3. 高效
4. 可自定义
5. 针对AI友好

缺点

1. 不能进行调试

主要说明

视图

• 工作助手：主项目树视图，用于管理 Swagger 项目和接口

常用命令

通过命令面板 (Ctrl+Shift+P / Cmd+Shift+P) 使用以下命令：

• 工作助手: 添加项目：输入 Swagger/OpenAPI 地址，加载并保存项目
• 工作助手: 查找路由：输入后端路由关键字，搜索并打开匹配接口
• 搜索请求 URL：在当前项目树中搜索接口
• 清空搜索：清除当前搜索关键词
• 修改标题：重命名选中项目
• 更新：刷新选中项目的 Swagger 配置
• 打开接口详情：在详情面板中查看接口请求/响应信息

使用步骤

1. 打开侧边栏中的 工作助手 视图。
2. 点击命令面板输入 工作助手: 添加项目，输入 Swagger 地址，例如 http://192.168.10.2:5008/swagger/index.html。
3. 项目加载完成后，展开项目节点查看 API 列表。
4. 双击接口或在上下文菜单中选择 打开接口详情 查看接口请求与响应样例。
5. 通过 搜索请求 URL 过滤接口，支持 method /path 类型的模糊匹配。

更新记录

查看扩展更新历史，请参阅 [CHANGELOG.md]。