swagger-search

一个VS Code扩展，用于在Swagger API文档中搜索和查看接口信息，支持完整Swagger UI URL解析和精确接口匹配。

Features

• 左侧面板搜索：提供独立的左侧活动栏面板，方便快速访问搜索功能
• 搜索历史记录：自动保存搜索过的接口，支持快速重新查看
• 接口记录管理：支持删除单个接口记录，保持搜索历史整洁
• Swagger URL支持：支持直接输入完整的Swagger URL进行精确接口匹配
• 模糊接口匹配：支持模糊匹配接口，可以输入部分接口路径进行模糊搜索
• 多服务支持：能够连接到多个Swagger服务并搜索所有服务中的接口
• 进度显示：提供搜索进度指示器，并支持取消操作
• 详细接口信息：显示接口的请求参数、响应结构、描述等信息
• 结构化展示：以树形结构展示请求和响应的参数
• Webview界面：提供美观的Webview界面展示接口详情
• 支持多种规范：兼容Swagger 2.0和OpenAPI 3.0规范

Requirements

• VS Code版本 1.96.0 或更高
• 需要能够访问Swagger资源的网络连接

Extension Settings

本扩展提供了以下配置选项：

• swagger-search.stopOnFirstMatch：如果为 true，搜索到第一个匹配的接口就停止搜索；如果为 false，会在所有服务中查找并返回所有匹配接口。默认值为 true。
• swagger-search.resourcesUrl：Swagger resources 列表的接口地址，例如: https://example.com/api/swagger-resources
• swagger-search.apiDocsBaseUrl：Swagger API文档的基础URL，例如: https://example.com/api，用于构建完整的API文档URL

Usage

方法1：使用命令面板

1. 打开VS Code命令面板 (Ctrl+Shift+P)
2. 输入并选择 Swagger: Search API 命令
3. 在输入框中输入要搜索的接口路径或完整的Swagger UI URL
4. 等待搜索完成
5. 从匹配结果中选择要查看的接口
6. 接口详情将在Webview面板中显示

方法2：使用左侧活动栏

1. 点击左侧活动栏中的Swagger Search图标
2. 在左侧面板中点击搜索按钮（放大镜图标）
3. 后续步骤同方法1的3-6

管理搜索记录

1. 在左侧面板中右键点击接口记录
2. 点击删除图标可删除该接口记录

Release Notes

0.0.1

• 初始版本，实现基本的Swagger API搜索和展示功能

Enjoy!