GitHub Copilot에서 Apidog CLI 사용법

GitHub Copilot 에이전트 모드가 Apidog API 테스트를 실행하도록 학습시키세요. 지침 파일 하나를 추가하고, 편집-테스트-수정(edit-test-fix) 루프에서 apidog run을 실행한 다음 종료 코드를 읽으세요.

INEZA Felin-Michel

INEZA Felin-Michel

14 July 2026

GitHub Copilot에서 Apidog CLI 사용법

Apidog 엔터프라이즈

온프레미스 배포

SSO & RBAC

SOC 2 준수

Apidog Enterprise 살펴보기

GitHub Copilot의 에이전트 모드는 루프를 이룹니다. 파일을 편집하고, 터미널 명령을 실행하고, 출력을 읽고, 다음에 무엇을 할지 결정합니다. 그렇다면 왜 API 테스트는 이 루프 안에 있지 않을까요? API 테스트는 GUI 뒤의 Apidog에 있으며, 누군가 클릭하는 것을 기억할 때 실행됩니다. Copilot은 이를 전혀 건드리지 않습니다.

해결책은 하나의 구성 파일입니다. Apidog CLI는 Apidog에서 빌드한 테스트 시나리오를 터미널에서 직접 실행하는 npm 패키지인 apidog-cli입니다. CLI가 설치되고 Copilot이 CLI의 존재를 알게 되면, 에이전트 모드는 단위 테스트를 실행하는 것과 동일한 방식으로 Apidog 시나리오를 실행합니다. 명령을 실행하고, 종료 코드를 읽고, 빨간색이면 코드를 수정합니다.

버튼

아직 CLI를 설치하지 않았다면 먼저 설치하십시오. AI 코딩 에이전트로 Apidog CLI 설치 방법은 에이전트가 타이핑하는 방식으로 npm 설치, 로그인 및 첫 실행 과정을 안내합니다. 이 문서에서는 apidog --version이 숫자를 출력하고 Apidog 계정이 인증되었다고 가정합니다.

어떤 Copilot에 관한 것인가

Copilot은 여러 제품으로 구성되어 있으며, 그 이름들이 혼란스럽게 중복됩니다. 이 글은 쉘 명령을 실행할 수 있는 인터페이스에 관한 것입니다.

주요 인터페이스는 VS Code의 에이전트 모드입니다. Copilot Chat 보기를 열고 모드 드롭다운을 에이전트로 전환하면, 여러 파일을 편집하고, 터미널 명령을 실행하며, 작업이 완료될 때까지 반복할 수 있습니다. 명령을 실행하려고 할 때, Copilot은 명령을 보여주고 실행하기 전에 확인을 요청합니다. 이 확인 단계가 바로 apidog run이 적합한 곳입니다.

어떤 것을 사용하고 있는지 알 수 있도록 두 가지 관련 인터페이스를 언급할 가치가 있습니다. Copilot 코딩 에이전트는 이슈를 할당한 후 GitHub Actions에서 비동기적으로 실행됩니다. 편집기에서 작업하는 대신 풀 리퀘스트를 생성합니다. Copilot CLI는 별도의 터미널 클라이언트입니다. 둘 다 명령을 실행할 수 있지만, 이 글은 VS Code의 에이전트 모드를 대상으로 합니다. 왜냐하면 그곳이 코드를 작성하는 동안 앉아 있는 곳이며, 편집-테스트-수정 루프가 가장 밀접하게 연결되어 있기 때문입니다. 아래 설정은 동일한 지침 파일을 읽는 코딩 에이전트에도 적용됩니다. Copilot이 에이전트가 되면서 무엇이 바뀌었는지에 대한 더 넓은 개요는 GitHub Copilot의 새로운 코딩 에이전트를 참조하십시오.

Copilot은 프로젝트 규칙을 학습하는 자체적인 방식을 가지고 있으며, 이 메커니즘이 일회성 "내 테스트 실행"을 Copilot이 스스로 찾는 대상으로 바꾸기 때문에 이러한 구분이 중요합니다. 이 메커니즘은 사용자 지정 지침 파일입니다.

1단계: Copilot의 지침 파일에 Apidog 규칙 추가

Copilot은 저장소의 루트에 있는 단일 파일인 .github/copilot-instructions.md에서 저장소 사용자 지정 지침을 읽습니다. 에이전트 모드, Copilot Chat, 코드 검토 및 코딩 에이전트는 모두 저장소 사용자 지정 지침에 대한 GitHub 문서에 따라 자동으로 이를 로드합니다. 이를 Claude Code의 CLAUDE.md 또는 Codex의 AGENTS.md라고 생각하십시오. Copilot이 작업을 시작하기 전에 컨텍스트로 가져오는 프로젝트 지침이 담긴 일반 Markdown 파일입니다.

## Apidog CLI를 사용한 API 테스트

API 엔드포인트를 변경할 때, 작업을 완료했다고 선언하기 전에 Apidog CLI로 확인하십시오. 다음을 실행하십시오:

    apidog run -t 812345 -e 671234 -r cli

- `apidog run`은 모든 어설션이 통과하면 0으로 종료하고, 실패가 있으면 0이 아닌 값으로 종료합니다.
  요약 텍스트가 괜찮아 보여도 0이 아닌 종료는 실패한 테스트로 간주하십시오.
- 머신은 이미 `apidog login`을 통해 인증되었습니다. `--access-token` 플래그를 추가하지 마십시오.
  그리고 이 파일에 토큰을 절대 넣지 마십시오.
- "알 수 없는 옵션" 오류가 발생하면 `apidog run --help`를 실행하고
  실제 플래그를 사용하십시오. 추측하지 마십시오.

다음 단계에서 실제 시나리오 및 환경 ID로 -t-e 값을 대체하십시오.

채팅에 언급하는 대신 지침 파일에 작성하십시오. 채팅에 입력된 시나리오 ID는 세션이 끝나면 사라지기 때문입니다. .github/copilot-instructions.md에 있는 ID는 모든 팀원, 모든 에이전트 모드 세션, 그리고 앞으로 코딩 에이전트가 여는 모든 풀 리퀘스트에 존재합니다. 규칙을 특정 파일에만 적용하려면 GitHub는 .github/instructions/NAME.instructions.md에 경로별 지침도 지원하지만, 여기서는 단일 저장소 전체 파일로 충분합니다.

2단계: Apidog에서 명령 가져오기

apidog run 명령을 직접 작성할 필요가 없습니다. Apidog가 자동으로 생성해 줍니다.

apidog run -t 812345 -e 671234 -r cli

이러한 정확한 ID를 .github/copilot-instructions.md의 블록에 붙여넣으십시오. 이 ID들은 신뢰할 수 있는 정보원입니다. Copilot과 지침 파일이 일치하지 않을 때는 CI/CD 탭의 내용이 우선합니다. 전체 플래그 및 리포터 세트에 대해서는 apidog run 명령 참조를 확인하십시오.

3단계: 에이전트 모드로 테스트 실행하기

VS Code에서 Copilot Chat 보기를 열고 모드 드롭다운을 에이전트로 전환하십시오. 에이전트 모드는 시작할 때 .github/copilot-instructions.md를 로드하므로, CLI의 존재를 이미 알고 있습니다. API에 영향을 미치는 변경을 하거나 직접 질문하십시오:

Apidog API 테스트 시나리오를 실행하고 결과를 알려줘.

Copilot은 지침 파일에서 apidog run 명령을 실행합니다. 에이전트 모드는 터미널 명령을 조용히 실행하지 않습니다. 명령을 보여주고 실행하기 전에 확인을 요청하므로, 어떤 명령이 실행될지 정확히 볼 수 있습니다. 이를 승인하십시오. 그러면 -r cli 리포터가 통합 터미널에 단계별 결과와 요약을 바로 출력하여, 각 요청과 어설션이 발생하는 것을 볼 수 있습니다.

두 가지를 확인해야 합니다. 실행이 진행되는 것과 Copilot이 요약 및 종료 코드를 보고하는 것입니다. 명령을 한 번 승인하면 VS Code는 작업 공간에서 해당 명령에 대한 선택을 기억하므로, 나중에 apidog run 호출은 다시 확인을 요청하지 않고 실행됩니다. 스테이징 환경에 대한 읽기 전용 테스트 시나리오는 허용해도 되는 안전한 작업 공간 내 명령 유형입니다.

4단계: Copilot 내에서 보고서 읽기

실행이 실패할 때(빨간색으로 표시될 때) 보고서에 답이 있습니다. -r cli를 사용하면 Copilot은 터미널에서 읽기 쉬운 상세 분석을 얻습니다. 각 요청, 각 어설션, 그리고 예상 값과 실제 값 중 어떤 것이 실패했는지 보여줍니다. 실패한 어설션은 정확한 필드 또는 상태 코드를 명시하며, 이는 Copilot이 다음 반복에서 수정 사항을 찾는 데 대개 충분합니다.

apidog run -t 812345 -e 671234 -r cli,html

html 리포터는 자가 포함된 파일을 ./apidog-reports에 작성합니다. Copilot이 다음 단계를 결정하기 위해 읽는 인라인 출력을 계속 얻을 수 있도록 목록에 cli를 유지하십시오. JUnit 출력 CI 대시보드 구문 분석을 포함한 모든 리포터 형식에 대해서는 완전한 Apidog CLI 가이드Apidog CLI 테스트 보고서 읽는 방법을 참조하십시오.

Copilot 자체 루프 내에서 테스트하기

중요한 점은 질문을 멈추고 지침 파일이 지시했기 때문에 Copilot이 스스로 시나리오를 실행할 때 발생하는 일입니다.

에이전트 모드가 결제 응답을 구축하는 핸들러를 편집하는 상황을 상상해 보십시오. 루프가 변경됩니다. 코드를 편집한 다음, 성공을 선언하는 대신 스테이징 환경에서 Apidog 시나리오를 실행하고 종료 코드를 읽고 그에 따라 조치합니다. 성공(초록색)이면 다음으로 진행합니다. 실패(빨간색)이면 보고서를 열고 어떤 어설션이 실패했는지(상태 코드, 누락된 필드, 잘못된 값) 읽고, 수정을 시도한 후 다시 실행합니다. API 테스트는 Copilot이 이미 단위 테스트를 실행하는 것과 동일한 편집-테스트-수정 루프의 일부가 됩니다. 당신은 하나의 지침을 작성했고 Copilot은 그 명령을 이미 작동하는 방식에 통합했습니다.

이것은 모든 에이전트 워크플로우를 안전하게 만드는 위임-검증 모델입니다. Copilot은 명령을 실행하고 결과를 읽습니다. 당신은 Apidog에서 시나리오를 시각적으로 계속 작성하고 에이전트가 종료 코드를 정직하게 읽는지 스팟 확인합니다. 더 넓은 패턴에 대해서는 API 테스트에 AI 에이전트를 사용하는 방법Apidog AI 테스트 하네스를 참조하십시오.

Copilot이 실제로 CLI를 실행하는지 확인

에이전트는 얻지 못한 성공을 보고하는 경우가 있으며, Copilot도 예외는 아닙니다. 문제를 얼마나 자주 잡아내는지 순서대로 세 가지 확인 사항을 알려드립니다.

첫째, 명령이 실제로 실행되었는지 확인하십시오. 에이전트 모드는 실행한 명령과 해당 출력을 터미널에 인라인으로 표시합니다. 실제 apidog run ... 줄과 그 아래 결과를 찾으십시오. Copilot이 테스트를 실행했다고 말했지만 명령을 볼 수 없다면, 실제로 하지 않은 일을 요약한 것입니다. 다시 실행하고 원시 출력을 보여달라고 요청하십시오.

둘째, 중요한 종료 코드를 확인하십시오:

What was the exit code of that apidog run command?

apidog run은 모든 어설션이 통과하면 0으로 종료하고, 실패가 있으면 0이 아닌 값으로 종료합니다. 이 단일 동작을 통해 Copilot 또는 파이프라인은 실행을 깔끔한 게이트로 처리할 수 있습니다. Copilot의 설명이 "테스트 통과"라고 말하지만 종료 코드가 0이 아니라면, 종료 코드가 맞습니다.

셋째, 실제 시나리오를 사용했는지 확인하십시오. 실행이 "시나리오를 찾을 수 없음"으로 실패하면, Copilot이 ID를 만들었거나 잘못 기억했을 수 있습니다. 지침 파일과 Apidog의 CI/CD 탭에서 생성된 명령에 대해 -t-e 값을 다시 확인하십시오. Apidog의 ID가 정확합니다.

선택 사항: Apidog MCP 서버 연결

지침 파일에서 apidog run을 실행하는 것은 필요한 대부분의 작업을 처리합니다. 한 단계 더 나아가려면 Apidog MCP 서버를 연결하십시오.

VS Code의 에이전트 모드는 MCP로 Copilot 확장 관련 GitHub 문서에 따라 저장소 루트에 있는 작업 공간 .vscode/mcp.json 파일에서 MCP 서버를 읽습니다. Apidog MCP 서버는 MCP를 통해 API 사양을 노출하므로, Copilot은 코드를 작성하는 동안 스키마를 읽을 수 있으며, 나중에 확인하는 것이 아닙니다. 작업 분할은 명확합니다. CLI는 테스트를 실행하고, MCP는 에이전트에 사양을 제공합니다.

대신 GitHub Actions에서 Copilot 코딩 에이전트를 실행하는 경우, 해당 MCP 구성은 다른 위치에 있습니다. 저장소 설정의 Copilot 섹션 아래 클라우드 에이전트에 JSON으로 추가하며, 모든 시크릿은 COPILOT_MCP_ 접두사가 붙은 Actions 시크릿으로 저장됩니다. .vscode/mcp.json 파일은 편집기 내 에이전트 모드용입니다.

Copilot이 잘못했을 때

설정 중에 몇 가지 실패가 자주 나타납니다.

지침 파일을 무시합니다. Copilot이 일반 명령을 실행하거나 전혀 실행하지 않는 경우, 파일이 로드되지 않을 수 있습니다. 파일 이름이 정확히 .github/copilot-instructions.md이고, 저장소 루트의 .github 디렉터리에 있으며, VS Code 설정에서 사용자 지정 지침이 활성화되어 있는지 확인하십시오. 경로가 잘못되면 Copilot은 절대 파일을 읽지 않습니다.

그래도 액세스 토큰을 전달합니다. Copilot이 --access-token을 추가하려고 시도한다면, 공개 예시에서 추측하는 것입니다. 머신이 apidog login을 통해 이미 인증되었으므로, 해당 블록은 이미 토큰을 추가하지 말라고 지시하고 있습니다. 해당 줄을 다시 강조하고, 실제 토큰을 지침 파일에 절대 넣지 마십시오. 인증 모델에 대해서는 Apidog CLI 인증을 참조하십시오.

플래그를 만들어냅니다. "알 수 없는 옵션" 오류는 Copilot이 설치된 버전에 없는 플래그를 추측했음을 의미합니다. apidog run --help를 실행하도록 지시하고 거기서 정확한 플래그를 복사하십시오. 이는 설치된 버전에 항상 올바른 플래그입니다.

실패한 실행에 대해 성공으로 보고합니다. 가장 비용이 많이 드는 문제이며, 종료 코드 규칙이 지침 파일과 확인 단계 모두에 있는 이유입니다. 요약과 종료 코드가 일치하지 않으면, 종료 코드가 우선합니다.

일상적인 에이전트에서 테스트된 루프로

이것이 설정 방법입니다. 설치 가이드에 따라 apidog-cli를 한 번 설치하고, 저장소의 .github/copilot-instructions.md에 짧은 Apidog 블록을 추가하면, Copilot은 코드를 편집하는 데 이미 사용하는 동일한 루프 내에서 API 테스트를 실행하고 결과를 읽는 방법을 알게 됩니다. 손상된 엔드포인트는 변경 사항을 배포한 후가 아니라 Copilot이 변경 작업을 하는 동안 포착됩니다.

GUI 뒤의 테스트는 사람이 클릭할 때 실행되지만, 한 줄짜리 명령은 Copilot이 결정할 때마다 실행됩니다. 당신은 Apidog에서 시나리오를 시각적으로 계속 구축하고, 당신이 보지 않는 곳에서 에이전트가 이를 실행합니다. Apidog 다운로드, 하나의 시나리오를 구축하고, 해당 apidog run 명령을 .github/copilot-instructions.md에 넣고, 다음 변경 시 Copilot이 이를 사용하는 것을 지켜보십시오. Copilot 없이 파이프라인에서 동일한 명령을 실행할 준비가 되면 GitHub Actions의 Apidog CLI에서 시크릿, 리포터 및 종료 코드 게이팅을 다룹니다.

Apidog에서 API 설계-첫 번째 연습

API를 더 쉽게 구축하고 사용하는 방법을 발견하세요