run

目的

対話型 TUI（Terminal User Interface） API エクスプローラーを起動します。ターミナルから離れることなく API エンドポイントを検索、ブラウズ、調査、呼び出しできるフルスクリーンアプリケーションです。

使用するタイミング

対話的に API を探索したい場合
すべての spec にわたって特定のエンドポイントを検索する必要がある場合
spec → collection → tag → endpoint の階層をブラウズしたい場合
MCP サーバーを設定する前に API 呼び出しをテストしたい場合

構文

bash

swag2mcp run [path]

引数

引数	位置	必須	説明
`path`	1	いいえ	ワークスペースディレクトリ。省略時はパス解決ルールに従います。

フラグ

なし。

モード

検索モード

すべての spec の全エンドポイントに対する全文検索。HTTP メソッド、タグ、パスによるフィルタリングをサポートします。

クエリを入力してエンドポイント名、パス、説明を検索
メソッド（GET、POST、PUT、DELETE など）で結果をフィルタリング
1 回のキー操作でエンドポイントの詳細を表示

ブラウズモード

spec 階層のツリー移動：

Spec → Collection → Tag → Endpoint

ツリーを下って特定のエンドポイントを見つける
エンドポイントの詳細を表示（パラメーター、リクエストボディ、レスポンス）
TUI から直接 API を呼び出す

ナビゲーション

キー	アクション
`↑` / `↓`	上下に移動
`Enter`	選択または開く
`Esc`	戻る
`Tab`	検索モードとブラウズモードを切り替え
`/`	検索入力をフォーカス
`q`	終了

コマンド実行後の確認

TUI はワークスペースからすべての spec を読み込みます。spec の読み込みに失敗した場合、インターフェースにエラーメッセージが表示されます。

ニュアンス

自動初期化: 設定ファイルが存在しない場合、run は自動的に init ウィザードを実行します。
フラグなし: run コマンドにはフラグがありません — すべての設定はワークスペースから取得されます。
ターミナルサイズ: TUI は最低 80×24 文字のターミナルが必要です。非常に小さいターミナルでは正しく表示されない場合があります。
依存関係: TUI は Bubbletea を使用します。SSH 経由およびほとんどのターミナルエミュレーターで動作します。