Skip to content

run

목적

대화형 TUI(터미널 사용자 인터페이스) API 탐색기를 실행합니다. 터미널을 떠나지 않고 API 엔드포인트를 검색, 탐색, 검사, 호출할 수 있는 전체 화면 애플리케이션입니다.

사용 시기

  • API를 대화형으로 탐색하려고 할 때
  • 모든 spec에서 특정 엔드포인트를 검색해야 할 때
  • spec → collection → tag → endpoint 계층 구조를 탐색하려고 할 때
  • MCP 서버를 설정하기 전에 API 호출을 테스트하려고 할 때

구문

bash
swag2mcp run [path]

인수

인수위치필수설명
path1아니요워크스페이스 디렉토리. 생략 시 경로 해결 규칙에 따라 결정됩니다.

플래그

없음.

모드

검색 모드

모든 spec의 모든 엔드포인트에 대한 전문 검색입니다. HTTP 메서드, 태그, 경로별 필터링을 지원합니다.

  • 쿼리를 입력하여 엔드포인트 이름, 경로, 설명 검색
  • 메서드(GET, POST, PUT, DELETE 등)로 결과 필터링
  • 한 번의 키 입력으로 엔드포인트 세부 정보 보기

탐색 모드

Spec 계층 구조를 통한 트리 탐색:

Spec → Collection → Tag → Endpoint
  • 트리를 따라 내려가 특정 엔드포인트 찾기
  • 엔드포인트 세부 정보 보기 (매개변수, 요청 본문, 응답)
  • TUI에서 직접 API 호출

탐색

동작
/ 위/아래 이동
Enter선택 또는 열기
Esc뒤로 가기
Tab검색과 탐색 모드 간 전환
/검색 입력 포커스
q종료

명령 후 검증

TUI는 워크스페이스에서 모든 spec을 로드합니다. spec 로드에 실패하면 인터페이스에 오류 메시지가 표시됩니다.

세부 사항

  • 자동 초기화: 설정 파일이 없으면 run이 자동으로 init 마법사를 먼저 실행합니다.
  • 플래그 없음: run 명령어에는 플래그가 없습니다 — 모든 설정은 워크스페이스에서 가져옵니다.
  • 터미널 크기: TUI는 최소 80×24 문자의 터미널이 필요합니다. 매우 작은 터미널에서는 올바르게 렌더링되지 않을 수 있습니다.
  • 의존성: TUI는 Bubbletea를 사용합니다. SSH 및 대부분의 터미널 에뮬레이터에서 작동합니다.