Apidog CLI는 터미널, CI 파이프라인, 자동화 워크플로우 또는 외부 시스템에서 API 테스트를 실행하기 위한 명령줄 진입점 역할을 오랫동안 해왔습니다.
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId>이러한 기반은 여전히 중요합니다. 팀은 여전히 API 테스트를 실행하고, 보고서를 생성하며, CI 내에서 품질 게이트를 유지하는 신뢰할 수 있는 방법을 필요로 합니다. 하지만 API 개발은 변화하고 있습니다. 이제 AI 에이전트가 API 설계, 테스트 생성, 디버깅, 마이그레이션 및 유지 관리에 참여하고 있습니다.
이러한 워크플로우에서 CLI는 기존 테스트를 실행하는 마지막 단계일 뿐만 아니라, 에이전트에게 API 자산을 읽고, 테스트 자산을 생성 또는 업데이트하며, 구조화된 변경 사항을 검증하고, 다시 기록하고, 결과를 확인하는 안정적인 방법을 제공해야 합니다.
업그레이드된 Apidog CLI는 기존의 테스트 실행 기반을 유지하면서 개발자, 스크립트 및 AI 에이전트를 위한 워크플로우 계층으로 확장합니다. 이 글에서는 AI 에이전트 시대에 CLI가 더욱 중요해지는 이유, Apidog CLI에서 변경된 사항, 그리고 팀이 API 테스트 자동화를 위해 이를 어떻게 사용하기 시작할 수 있는지 설명합니다.
AI 에이전트 시대에 CLI가 더욱 중요한 이유
그래픽 인터페이스는 사람을 위해 설계되었습니다. 시각적이고 유연하며 탐색에 유용합니다. 그러나 AI 에이전트는 구조화된 명령, 예측 가능한 입력, 예측 가능한 출력 및 명확한 검증 단계에서 가장 잘 작동합니다.
바로 이 지점에서 CLI가 중요해집니다. CLI는 개발자가 Apidog에서 관리하는 것과 동일한 리소스(API, 환경, 변수, 테스트 케이스, 테스트 시나리오, 테스트 스위트, 보고서, 가져오기/내보내기 데이터 등)에 대해 에이전트와 스크립트에 반복 가능한 인터페이스를 제공합니다.
실제로 이는 Apidog이 사람 사용자뿐만 아니라 자동화된 워크플로우에도 서비스를 제공할 수 있음을 의미합니다. 사람들은 제품 인터페이스에서 계속해서 설계, 디버깅, 검토 및 협업을 수행합니다. 에이전트와 자동화는 CLI를 사용하여 동일한 자산에 대해 통제된 작업을 수행할 수 있습니다.
apidog run에서 완전한 API 및 테스트 워크플로우로
이전 CLI 경험은 주로 테스트 실행에 중점을 두었습니다. 이로 인해 apidog run은 CI 품질 게이트로서 유용했지만, CLI가 보통 워크플로우의 끝 부분에 나타난다는 의미이기도 했습니다. 업그레이드된 CLI는 더 많은 핵심 Apidog 리소스로 범위를 확장하여 자동화가 더 일찍 참여할 수 있도록 합니다. 즉, 프로젝트 컨텍스트 읽기, 테스트 자산 준비, 구조화된 변경 사항 검증, 그리고 검증 실행을 할 수 있습니다.
업그레이드된 CLI를 통해 사용자 및 에이전트는 다음과 같은 리소스를 사용할 수 있습니다.
- 프로젝트 및 프로젝트 메타데이터
- API 및 API 정의
- 환경 및 변수
- 테스트 케이스
- 테스트 시나리오
- 테스트 스위트
- 보고서
- 가져오기 및 내보내기 워크플로우
- 계정, 브랜치, 러너 및 관련 프로젝트 리소스
이는 Apidog CLI의 역할을 변화시킵니다. 더 이상 모든 작업이 완료된 후 테스트를 실행하는 단순한 방법이 아닙니다. 이제 에이전트가 프로젝트를 이해하고, 테스트 자산을 생성 또는 업데이트하며, 변경 사항을 검증하고, 검증을 실행해야 하는 개발 루프의 초기 단계에 참여할 수 있습니다.
에이전트 기반 테스트를 위한 더 안전한 루프
AI 에이전트가 API 개발 또는 테스트를 지원할 때 위험한 부분은 단순히 콘텐츠를 생성하는 것만이 아닙니다. 위험한 부분은 생성된 콘텐츠를 충분한 구조나 검증 없이 실제 프로젝트에 기록하는 것입니다.
업그레이드된 CLI는 더 안전한 루프를 가능하게 합니다.
이 루프는 많은 Apidog 리소스가 구조화되어 있기 때문에 중요합니다. 테스트 케이스와 테스트 시나리오는 요청 데이터, 어설션, 변수 추출, 전처리자, 후처리자, 단계 순서, 환경 참조 및 기타 세부 정보를 포함할 수 있습니다. 에이전트가 구조를 추측할 경우, 작은 실수로 인해 쓰기 실패, UI에 불완전한 표시 또는 예상대로 작동하지 않는 테스트가 발생할 수 있습니다.
이것이 cli-schema가 업그레이드의 중요한 부분인 이유입니다. 복잡한 JSON 파일을 Apidog에 기록하기 전에 에이전트는 CLI에 필드와 구조가 예상 스키마와 일치하는지 검증하도록 요청할 수 있습니다.
apidog cli-schema validate test-case-create --file ./test-case-create.json
apidog cli-schema validate test-scenario-update --file ./scenario-update.json요약하자면, 에이전트가 생성하도록 하되, 기록이 발생하기 전에 CLI가 검증하도록 하십시오.
CLI는 또한 명령 출력에 에이전트 중심의 힌트를 제공할 수 있습니다. 리소스가 생성 또는 업데이트된 후 다음 단계는 종종 "중단"이 아닙니다. 더 신뢰할 수 있는 에이전트는 저장된 리소스를 다시 읽고 구조를 확인하며, 적절할 때 테스트를 실행해야 합니다. 이러한 힌트는 에이전트가 사각지대 없이 워크플로우를 진행하는 데 도움이 됩니다.
스킬은 에이전트에게 운영 판단력을 부여합니다
CLI 명령은 에이전트에게 실행 능력을 부여합니다. 스킬은 에이전트에게 운영 판단력을 부여합니다.
스킬(SKILL)은 단순히 명령 참조가 아닙니다. 이는 AI 에이전트를 위해 작성된 운영 가이드에 더 가깝습니다. 즉, 언제 명령을 사용해야 하는지, 어떤 명령이 먼저 와야 하는지, 어떤 필드를 추측해서는 안 되는지, 언제 검증해야 하는지, 언제 다시 읽어야 하는지, 그리고 언제 테스트를 실행해야 하는지를 알려줍니다.
예를 들어, 신뢰할 수 있는 에이전트는 항상 대규모 테스트 시나리오를 처음부터 수동으로 작성해서는 안 됩니다. 더 안전한 패턴은 종종 다음과 같습니다.
- 기본 시나리오를 생성합니다.
- API 또는 기존 테스트 케이스에서 단계를 가져옵니다.
- 전체 시나리오 구조를 다시 읽습니다.
- 어설션, 변수 추출 또는 프로세서를 더 작은 단계로 업데이트합니다.
- 시나리오를 검증하고 실행합니다.
스킬은 이러한 패턴을 명시적으로 만듭니다. 스킬은 에이전트가 잘못된 필드 이름을 사용하거나, 잘못된 열거형 값을 선택하거나, 스키마 검증을 건너뛰거나, 쓰기 성공이 최종 리소스가 이미 올바르다는 의미라고 가정하는 것과 같은 일반적인 실수를 피하도록 돕습니다.
Apidog은 에이전트가 CLI 명령, 리소스 구조 및 작업 워크플로우를 이해하는 데 도움이 되는 8가지 동반 스킬을 제공합니다. CLI와 스킬은 함께 Apidog을 AI 지원 API 개발 및 테스트에 더욱 실용적으로 만듭니다.
AI 브랜치를 통한 더 안전한 프로젝트 변경
에이전트가 프로젝트 리소스를 수정할 때 안전성과 검토 가능성이 중요합니다. 이러한 이유로 업그레이드된 CLI는 AI 브랜치와 함께 사용될 수도 있습니다.
에이전트는 먼저 격리된 브랜치에서 변경 사항을 만들 수 있습니다. 팀은 차이점을 검토하고 결과를 확인한 다음 대상 브랜치로 병합할 수 있습니다. 이는 자동화된 변경 사항이 메인 브랜치 또는 공유 협업 브랜치에 직접적인 영향을 미치는 것을 방지하는 데 도움이 됩니다.
실제 워크플로우에서 가능해지는 것
업그레이드된 CLI의 가치는 구체적인 워크플로우에서 가장 쉽게 확인할 수 있습니다.
API 정의로부터 테스트 생성
에이전트는 프로젝트에서 API 정의를 읽고, 테스트 케이스를 생성하며, cli-schema로 생성된 JSON을 검증하고, 테스트 케이스를 Apidog에 기록하고, 다시 읽어와 검증을 실행할 수 있습니다. 이는 테스트 생성을 일회성 제안에서 통제된 워크플로우로 전환시킵니다.
복잡한 테스트 시나리오 유지 관리
다단계 시나리오의 경우, 에이전트는 먼저 API 또는 기존 테스트 케이스에서 단계를 가져온 다음, 전체 구조를 다시 읽은 후 어설션, 변수 또는 프로세서를 업데이트할 수 있습니다. 이는 대규모 시나리오를 한 번에 잘못 구축할 위험을 줄여줍니다.
apidog test-scenario import-steps <scenarioId> --project <projectId> --source endpoint --ids <endpointIds> --sync manual
apidog test-scenario get <scenarioId> --project <projectId> --with-case-detail프로젝트 자산 이동 및 재현
업그레이드된 CLI는 Apidog 네이티브 데이터의 가져오기 및 내보내기 워크플로우도 개선합니다. 이는 프로젝트 마이그레이션, 고객 환경 재현, 테스트 설정 복사 또는 프로젝트 간 API, 스키마, 테스트 케이스 및 시나리오 이동에 유용합니다.
apidog export --project <projectId> --format apidog --output ./project.apidog.json
apidog import --project <projectId> --format apidog --file ./project.apidog.jsonCI 품질 게이트 유지
새로운 에이전트 지원 기능은 CI를 대체하지 않습니다. 오히려 보완합니다. 팀은 여전히 apidog run을 자동화된 테스트 실행 및 보고서의 핵심 진입점으로 사용할 수 있습니다.
apidog run --project <projectId> --test-scenario <scenarioId> --environment <environmentId> -r "cli,html,junit" --out-dir ./apidog-reports시작하기
Apidog CLI가 이미 설치되어 있다면, 먼저 현재 버전을 확인하세요.
apidog -vApidog CLI 버전이 2.2.5보다 이전이라면, 새로운 기능을 사용하기 전에 CLI를 업데이트하세요. 이 버전 번호는 Apidog 앱이 아닌 Apidog CLI를 나타냅니다.
사용 중인 AI 에이전트에 다음 프롬프트를 복사하여 Apidog CLI와 동반 스킬을 모두 설치하도록 요청할 수 있습니다.
Read the instructions and help me install Apidog CLI:
https://apidog.com/apidog-cli-installation-guide.md수동으로 설치 또는 업데이트하려면 다음을 실행하세요.
npm install -g apidog-cli@latest전체 명령 참조는 Apidog CLI 옵션을 참조하세요.
첫 번째 에이전트 작업 시도하기
CLI와 스킬이 설치되면, 가장 쉽게 시작하는 방법은 에이전트에게 작고 위험 부담이 적은 API 작업을 하나 주는 것입니다. 예를 들어, Apidog 프로젝트에 간단한 헬스 체크 엔드포인트를 생성하도록 요청한 다음, 결과를 확인하기 위해 다시 읽어오도록 하세요.
이 프롬프트를 AI 에이전트에 복사하세요.
Use Apidog CLI to help me create my first API endpoint in Apidog. First, check my Apidog CLI setup and list the projects I can access. Ask me which project to use. After I confirm, create a simple GET /health endpoint named Health Check with a 200 response example. Validate any structured input before writing, then read the endpoint back and summarize what was created.이는 새로운 사용자에게 구체적인 시작점을 제공합니다. 즉, 에이전트가 설정을 확인하고, 프로젝트에 기록하기 전에 묻고, 작은 API 정의를 생성하며, 저장된 결과를 확인합니다.
다음 단계:
- 하나의 작업 공간에서 API를 설계, 디버깅, 테스트 및 문서화하려면 Apidog을 다운로드하세요.
- 명령줄 API 테스트, CI 자동화 및 AI 에이전트 워크플로우에 대한 자세한 내용은 Apidog CLI에 대해 자세히 알아보세요.
자주 묻는 질문
Apidog CLI란 무엇인가요?
Apidog CLI는 API 테스트를 실행하고, Apidog 프로젝트 리소스를 다루며, Apidog API 및 테스트 자산을 자동화 워크플로우에 연결하는 명령줄 도구입니다.
Apidog CLI가 CI에서 API 테스트를 실행할 수 있나요?
네. 팀은 CI 파이프라인에서 apidog run을 사용하여 API 테스트를 실행하고, 보고서를 생성하며, 테스트 워크플로우에 자동화된 품질 게이트를 유지할 수 있습니다.
Apidog CLI는 AI 에이전트에게 어떻게 도움이 되나요?
Apidog CLI는 AI 에이전트에게 API 정보를 읽고, 테스트 자산을 생성 또는 업데이트하며, 변경 사항을 검증하고, Apidog에 기록하고, 결과를 다시 읽어와 검증을 위해 테스트를 실행하는 구조화된 방법을 제공합니다.
Apidog CLI에서 cli-schema란 무엇인가요?
cli-schema는 복잡한 JSON 파일이 Apidog에 기록되기 전에 유효성을 검사하는 데 도움이 됩니다. 이는 에이전트가 테스트 케이스 및 테스트 시나리오를 생성하거나 업데이트할 때 쓰기 실패, 잘못된 필드 및 불필요한 재시도 루프를 줄여줍니다.
Apidog CLI는 어떻게 설치하나요?
AI 에이전트에게 Apidog CLI 설치 가이드를 따르도록 요청하여 CLI와 동반 스킬을 모두 설치할 수 있으며, 또는 npm install -g apidog-cli@latest 명령으로 수동으로 설치할 수 있습니다.