run

Назначение

Запустить интерактивный TUI (Terminal User Interface) — обозреватель API. Это полноэкранное приложение для поиска, просмотра, изучения и вызова эндпоинтов API, не выходя из терминала.

Когда использовать

• Вы хотите интерактивно исследовать свои API
• Вам нужно найти конкретный эндпоинт по всем спецификациям
• Вы хотите просмотреть иерархию спецификация → коллекция → тег → эндпоинт
• Вы хотите протестировать вызов API перед настройкой MCP-сервера

Синтаксис

swag2mcp run [path]

Аргументы

Аргумент	Позиция	Обязательно	Описание
path	1	Нет	Директория рабочей области. Если не указан, разрешается по правилам разрешения пути.

Флаги

Нет.

Режимы

Режим поиска

Полнотекстовый поиск по всем эндпоинтам во всех спецификациях. Поддерживает фильтрацию по HTTP-методу, тегу и пути.

• Введите запрос для поиска по именам эндпоинтов, путям и описаниям
• Фильтруйте результаты по методу (GET, POST, PUT, DELETE и т.д.)
• Просматривайте детали эндпоинта одним нажатием клавиши

Режим обзора

Древовидная навигация по иерархии спецификаций:

Спецификация → Коллекция → Тег → Эндпоинт

• Перемещайтесь по дереву для поиска конкретных эндпоинтов
• Просматривайте детали эндпоинта (параметры, тело запроса, ответы)
• Вызывайте API напрямую из TUI

Навигация

Клавиша	Действие
↑ / ↓	Перемещение вверх/вниз
Enter	Выбор или открытие
Esc	Назад
Tab	Переключение между режимами поиска и обзора
/	Фокус на поле поиска
q	Выход

Проверка после команды

TUI загружает все спецификации из рабочей области. Если спецификация не загружается, в интерфейсе отображается сообщение об ошибке.

Нюансы

• Автоинициализация: Если файл конфигурации не существует, run автоматически запускает мастер инициализации.
• Нет флагов: Команда run не имеет флагов — вся конфигурация берётся из рабочей области.
• Размер терминала: TUI требует терминал размером не менее 80×24 символов. Он может некорректно отображаться в очень маленьких терминалах.
• Зависимости: TUI использует Bubbletea. Он работает через SSH и в большинстве эмуляторов терминала.