OneADDS API VSCode 插件

作者：Czh | Prh 本插件是为 oneadds-api 工具量身打造的 VSCode 辅助工具，旨在将 API 文档与代码生成无缝集成到您的开发环境中，提供高效、便捷的 API 浏览和管理体验。

✨ 核心特性

• API 树状视图: 在 VSCode 侧边栏直观地展示所有 API。
• 智能分组:
  • 自动分组: 如果项目的 Swagger 服务支持 swagger-config，插件将自动获取分组信息，并以 分组 -> 模块 -> 接口 的三级结构进行展示。
  • 优雅回退: 如果无法获取分组信息，插件会自动回退，以 模块 -> 接口 的二级结构展示，确保在不同环境下的可用性。
• 丰富的视图操作:
  • 初始化项目: 一键执行 npx oneadds-api init，快速生成配置文件。
  • 生成 API 代码: 一键执行 npx oneadds-api build，并将生成的文件夹在资源管理器中高亮显示。
  • 实时搜索: 在视图内对模块、路径、描述等信息进行模糊搜索，快速定位目标接口。
  • 刷新视图: 手动与远程 API 文档同步，更新树状视图。
• 强大的接口详情:
  • 独立视图: 点击任意接口，将在新的 Webview 标签页中展示其详细信息。
  • 结构化展示: 清晰地列出请求参数、请求体、响应状态、响应参数及响应示例。
  • 层级化参数: 对复杂的请求体和响应参数（如嵌套对象、数组）提供带缩进和折叠功能的层级视图，方便查阅。
  • 浏览器联动: 在接口详情页和视图标题栏都提供了"在浏览器中打开"的按钮，可一键跳转到 Knife4j 或 Swagger UI 的对应接口文档页面。
• 自定义图标: 拥有一个精心设计的独立插件图标。

🚀 使用指南

1. 安装插件

• 您可以将本项目打包成 .vsix 文件。
• 打开 VSCode，在插件市场侧边栏中，点击右上角的 ... 菜单，选择 "从 VSIX 安装..."，然后选中打包好的文件。

2. 初始化项目

1. 在 VSCode 中打开您的项目文件夹。
2. 在左侧活动栏中点击本插件的图标，打开 API 视图。
3. 如果项目中缺少 oneadds-api.config.json 文件，视图上方会显示一个 "初始化项目" ( + ) 图标，点击它。
4. 插件会自动在项目根目录为您生成 oneadds-api.config.json 文件。

3. 配置与使用

1. 打开 oneadds-api.config.json 文件，将其中的 url 字段修改为您的项目对应的 Swagger/OpenAPI 文档地址 (例如：http://localhost:8080/v3/api-docs)。
2. 保存文件后，API 视图将自动刷新并加载所有接口。
3. 现在，您可以开始浏览、搜索和查看您的 API 了。

📂 命令列表

📦 如何打包

要将此项目打包成 .vsix 文件以供分发和安装，请执行以下步骤：

1. 安装 VSCE (一次性):

   npm install -g @vscode/vsce
   

2. 进入项目根目录:

   cd path/to/oneadds-vscode-plugin
   

3. 执行打包命令:

   vsce package
   

打包成功后，会在项目根目录下生成 oneadds-vscode-plugin-x.x.x.vsix 文件。

享受高效的 API 开发体验吧！