run

用途

启动交互式 TUI（终端用户界面） API 浏览器。这是一个全屏应用程序，用于搜索、浏览、检查和调用 API 端点，无需离开终端。

何时使用

• 你想交互式地探索你的 API
• 你需要跨所有 spec 搜索特定端点
• 你想浏览 spec → collection → tag → endpoint 层次结构
• 你想在配置 MCP 服务器之前测试 API 调用

语法

swag2mcp run [path]

参数

参数	位置	必需	描述
path	1	否	工作区目录。如果省略，通过路径解析规则解析。

标志

无。

模式

搜索模式

跨所有 spec 中所有端点的全文搜索。支持按 HTTP 方法、标签和路径过滤。

• 输入查询以搜索端点名称、路径和描述
• 按方法过滤结果（GET、POST、PUT、DELETE 等）
• 一键查看端点详情

浏览模式

通过 spec 层次结构进行树形导航：

Spec → Collection → Tag → Endpoint

• 向下导航树以查找特定端点
• 查看端点详情（参数、请求体、响应）
• 直接从 TUI 调用 API

导航

按键	操作
↑ / ↓	向上/向下导航
Enter	选择或打开
Esc	返回
Tab	在搜索和浏览模式之间切换
/	聚焦搜索输入
q	退出

命令后验证

TUI 从工作区加载所有 spec。如果 spec 加载失败，界面中会显示错误消息。

细节

• 自动初始化： 如果不存在配置文件，run 会自动先运行初始化向导。
• 无标志： run 命令没有标志 — 所有配置来自工作区。
• 终端大小： TUI 需要至少 80×24 字符的终端。在非常小的终端中可能无法正确渲染。
• 依赖： TUI 使用 Bubbletea。它可以通过 SSH 和在大多数终端模拟器中工作。