Skip to content

TUI 浏览器

概述

swag2mcp 包含一个内置的 TUI(终端用户界面),用于交互式 API 探索。它是一个全屏终端应用程序,让你无需离开终端即可搜索、浏览、检查和调用 API 端点。

启动

bash
swag2mcp run

如果不存在配置文件,TUI 将自动首先启动初始化向导。

模式

TUI 有三种模式,可使用 Tab 键切换:

搜索模式

跨所有 spec 中所有端点的全文搜索。支持与 search MCP 工具相同的查询语法。

  • 输入查询以搜索端点名称、路径和描述
  • 按方法、标签或路径过滤结果
  • 一键查看端点详情
  • 分页浏览结果(每页 10 项)

浏览模式

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

Spec → Collection → Tag → Endpoint
  • 向下导航树以查找特定端点
  • 查看端点详情(参数、请求体、响应)
  • 直接从 TUI 调用 API
  • 将端点详情保存为 JSON 文件

认证模式

查看任何 spec 的认证令牌和头。用于调试或生成 curl 命令。

控制

按键操作
/ 向上/向下导航
Enter选择或打开
Esc返回上一级
Tab在搜索、浏览和认证模式之间切换
/聚焦搜索输入
N / P下一页 / 上一页
B返回上一屏幕
M返回主菜单
S将端点详情保存为 JSON 文件
q / Ctrl+C退出

状态

TUI 在导航过程中经历以下状态:

  1. 加载中 — 从工作区加载数据
  2. 搜索 — 带查询输入的搜索模式
  3. 浏览 — 带 spec 列表的浏览模式
  4. Spec 列表 — 所有 spec 的列表
  5. Collection 列表 — spec 内的 collection
  6. Tag 列表 — collection 内的标签
  7. 端点列表 — 标签内的端点
  8. 端点详情 — 完整的端点信息
  9. 调用结果 — API 调用结果
  10. 错误 — 带消息的错误状态

端点详情视图

当你选择一个端点时,TUI 显示:

  • HTTP 方法和路径
  • 基础 URL 和完整 URL
  • 摘要和描述
  • 所有参数(名称、位置、类型、必需)
  • 请求体模式(如果适用)
  • 响应码和模式
  • 弃用状态

要求

  • 终端大小: 至少 80×24 字符
  • 终端模拟器: 适用于大多数现代终端(iTerm2、Terminal.app、GNOME Terminal、Windows Terminal 等)
  • SSH: 可通过 SSH 连接工作

重要说明

  • 自动初始化 — 如果不存在配置文件,TUI 自动启动初始化向导
  • 分页 — 列表每页 10 项。使用 NP 导航
  • 保存端点详情 — 在端点详情视图中按 S 将完整详情保存为当前目录中的 JSON 文件
  • 认证模式 — 显示用于调试的令牌和头。在生产环境中,可以使用 --disable-llm-auth 禁用 auth 工具