우리는 매일 API를 구축하며, 자동화, 테스트 및 오케스트레이션의 필요성이 중요합니다. 사용자 친화적인 인터페이스로 잘 알려진 Postman은 더 깊이 있는 자동화 및 CI/CD 워크플로우를 지원하기 위해 Command Line Interface (CLI)를 도입했습니다.
Postman CLI는 단순히 테스트를 트리거하는 도구가 아니라, API 상호작용을 스크립팅하고 기존 파이프라인과 통합하며 여러 환경에서 API의 무결성을 보장할 수 있는 광범위한 유틸리티입니다. 이 글에서는 Postman CLI의 고급 기능을 탐구하며, API 개발 및 테스트 관행을 어떻게 향상시킬 수 있는지 보여줍니다.
Postman CLI의 발전
기술적 세부 사항에 들어가기 전, Postman이 CLI를 도입한 이유를 이해하는 것이 중요합니다. Postman의 그래픽 인터페이스는 상호작용적인 사용에 완벽하며, API 탐색, 테스트 및 디버깅에 이상적입니다.
하지만 현대 DevOps 환경에서 자동화는 필수적입니다. 지속적인 통합/지속적인 배포 (CI/CD) 파이프라인은 API의 자동화된 테스트 및 검증을 요구하며, 그곳에서 Postman의 CLI가 필요합니다. CLI는 수동 API 테스트와 완전히 자동화되고 통합된 API 워크플로우 간의 간극을 연결합니다. 이 유틸리티는 팀이 터널에서 컬렉션, 테스트 및 통합을 직접 실행할 수 있게 해주어 자동화된 환경에서 효율적이고 반복 가능한 프로세스를 여는 가능성을 제공합니다.
Postman CLI를 설치하고 설정하는 방법은?
Postman CLI는 독립형 도구가 아니라, 일반적으로 workspace, 컬렉션 및 환경에 대한 접근을 인증하기 위해 Postman API 키가 설정된 환경이 필요합니다. 이는 CI/CD 플랫폼과 통합할 때, 특히 환경에서 스크립트를 안전하고 원활하게 실행하는 데 중요합니다.
설정을 위해 CLI를 설치해야 합니다. Postman 문서에는 도움이 될 만한 문서 가이드가 있습니다.
Windows 설치
다음 명령을 실행하여 Windows용 Postman CLI를 설치합니다. 이는 설치 스크립트를 다운로드하고 실행합니다. 설치 스크립트는 아직 존재하지 않으면 %USERPROFILE%\AppData\Local\Microsoft\WindowsApps 디렉토리를 생성한 다음, 그곳에 postman 바이너리를 설치합니다.
powershell.exe -NoProfile -InputFormat None -ExecutionPolicy AllSigned -Command "[System.Net.ServicePointManager]::SecurityProtocol = 3072; iex ((New-Object System.Net.WebClient).DownloadString('https://dl-cli.pstmn.io/install/win64.ps1'))"
Mac (Apple 실리콘) 설치
다음 명령을 실행하여 Apple 실리콘 프로세서를 사용하는 Mac용 Postman CLI를 설치합니다. 이는 설치 스크립트를 다운로드하고 실행합니다. 설치 스크립트는 아직 존재하지 않으면 /usr/local/bin 디렉토리를 생성한 다음, 그곳에 postman 바이너리를 설치합니다.
curl -o- "https://dl-cli.pstmn.io/install/osx_arm64.sh" | sh
Mac (Intel) 설치
다음 명령을 실행하여 Intel 칩이 장착된 Mac용 Postman CLI를 설치합니다. 이는 설치 스크립트를 다운로드하고 실행합니다. 설치 스크립트는 아직 존재하지 않으면 /usr/local/bin 디렉토리를 생성한 다음, 그곳에 postman 바이너리를 설치합니다.
curl -o- "https://dl-cli.pstmn.io/install/osx_64.sh" | sh
Linux 설치
최신 Linux 버전용 Postman CLI를 설치하려면 다음 명령을 실행합니다. 이는 설치 스크립트를 다운로드하고 실행합니다. 설치 스크립트는 아직 존재하지 않으면 /usr/local/bin 디렉토리를 생성한 다음, 그곳에 postman 바이너리를 설치합니다.
curl -o- "https://dl-cli.pstmn.io/install/linux64.sh" | sh
설치가 완료되면, Postman API 키를 사용하여 인증합니다. 이 API 키는 Postman의 백엔드에서 안전하게 관리됩니다:
postman login --with-api-key ABCD-1234-1234-1234-1234-1234
이 API 키 관리 시스템은 CLI 실행이 Postman 웹 또는 데스크탑 인터페이스의 어떤 세션과도 동일한 수준의 접근 및 보안을 갖추도록 보장합니다.
컬렉션 및 환경 실행
Postman CLI는 Postman 테스트의 핵심인 컬렉션 실행을 허용합니다. Postman의 컬렉션은 테스트해야 하는 API 호출의 워크플로우 또는 순서를 나타냅니다. 컬렉션은 배포 단계에 따라 변동하는 기본 URL, 인증 토큰 또는 기타 구성 세부 사항을 저장하는 환경과 자주 연결됩니다(예: 개발, 스테이징, 프로덕션).
좀 더 고급 기능之一은 특정 환경에서 컬렉션을 실행할 수 있는 능력입니다. 이는 컬렉션 자체를 수정하지 않고도 여러 환경에서 복잡한 API 흐름을 테스트할 수 있게 해줍니다:
postman run <collection.json> --environment <environment.json>
이 단순하면서도 강력한 명령은 여러 테스트 스위트를 다양한 구성에서 실행할 수 있도록 하여, CLI가 CI/CD 파이프라인에서 API 테스트를 조정하는 데에 매우 유용하게 만들어 줍니다.
고급 구성: 전역 및 환경 변수
Postman CLI의 변수 처리 또한 또 다른 고급 기능입니다. 동적 환경의 도입으로, 전역, 환경 및 로컬 변수를 즉시 재정의하고 관리할 수 있습니다. 이 기능은 테스트의 여러 단계에서 여러 API 매개변수가 동적으로 변경되어야 하는 고급 워크플로우에 필수적입니다.
API에 동적 인증 토큰이 필요한 시나리오를 고려해보세요. 토큰을 하드코딩하는 대신, Postman CLI를 사용하여 이를 동적으로 주입할 수 있습니다:
postman run <collection.json> --env-var token=<new_token>
보다 복잡한 시나리오에서는 이러한 값을 외부 파일에서 로드하거나 Postman의 컬렉션 사전 요청 스크립트를 통해 관리하거나, CI 플랫폼에서 런타임 동안 환경 변수로 전달할 수 있습니다. 이 유연성 덕분에 Postman CLI는 복잡한 API 인증 흐름을 처리하는 데 매우 강력하게 작용합니다.
테스트 실행 및 사용자 정의 보고
Postman CLI는 JavaScript로 작성된 자동화된 테스트가 포함된 Postman 컬렉션의 실행을 지원합니다. 이러한 테스트는 API 응답의 무결성을 검사하거나, 스키마를 검증하거나, 응답 시간을 미리 정의된 임계값과 비교할 수 있습니다.
컬렉션을 실행할 때, CLI는 자세한 로깅 및 보고를 제공합니다. 기본적으로 출력은 어떤 테스트가 통과했는지 또는 실패했는지를 보여주는 구조화된 형식으로 렌더링됩니다. 그러나 Postman CLI는 기본 로깅을 넘어서 나아갑니다. 고급 사용자는 JSON, HTML 및 JUnit XML을 포함한 여러 형식으로 사용자 정의 보고서를 생성할 수 있으며, 이는 Jenkins 또는 GitLab과 같은 CI 플랫폼과의 통합에 중요합니다:
postman run <collection.json> --reporters cli,json --reporter-json-export output.json
이 명령은 컬렉션을 실행할 뿐만 아니라, 결과를 CLI 및 JSON 형식으로 출력하여 대시보드 도구와의 추가 조작이나 통합을 가능하게 합니다.
심층 분석: Newman과 Postman CLI 작업하기
Postman CLI 도입 이전, Newman은 명령줄에서 Postman 컬렉션을 실행하는 데에 주요 도구였습니다. Newman은 특히 일부 레거시 워크플로우에 여전히 중요하지만, Postman CLI는 여러 가지 향상을 제공합니다. Postman의 클라우드 플랫폼과 직접 통합되어, 보다 원활한 인증 및 환경 관리를 제공합니다.
예를 들어, Postman CLI는 Postman의 클라우드에서 직접 공유된 작업 공간에 접근할 수 있어, 컬렉션 및 환경을 로컬에서 다운로드하고 관리할 필요가 없습니다. 또한, Postman의 작업 공간 구성을 통해 고급 인증 메커니즘(OAuth2, 배어러 토큰 등)을 기본적으로 지원하여, 클라우드 통합 워크플로우에 보다 강력한 솔루션을 제공합니다.
여기 Newman과 Postman CLI를 사용하여 간단한 컬렉션 실행을 비교한 것입니다:
Newman:
newman run <collection.json> --environment <environment.json>
Postman CLI:
postman run <collection>
여기서의 주요 차이는 Postman CLI가 클라우드에서 Postman 작업 공간으로부터 컬렉션과 환경을 직접 참조할 수 있다는 것으로, 보안이 높거나 빠르게 변화하는 구성의 환경에 더 유연하게 작용합니다.
Postman CLI를 CI/CD 파이프라인에 통합하기
Postman CLI를 사용하는 주요 이유 중 하나는 CI/CD 파이프라인과의 통합입니다. 파이프라인에서 자동화된 API 테스트는 개발 주기 초기에 문제를 감지하는 데에 중요해집니다. Jenkins, CircleCI, GitLab CI 및 GitHub Actions와 같은 도구는 모두 다양한 파이프라인 단계에서 API 테스트를 실행하기 위해 Postman CLI 명령을 호출할 수 있습니다.
다음은 Postman CLI를 Jenkins 파이프라인에 통합하기 위한 예입니다:
pipeline {
agent any
stages {
stage('Run Postman Tests') {
steps {
script {
sh 'postman run <collection> --reporters cli,junit --reporter-junit-export results.xml'
}
}
}
}
post {
always {
junit 'results.xml'
}
}
}
이 Jenkinsfile은 Postman 컬렉션을 실행하고, 테스트 결과를 Jenkins의 JUnit 플러그인과 호환되는 형식으로 캡처하여 테스트 결과에 따라 보고서를 생성합니다.
Postman CLI는 또한 파이프라인 내에서 테스트 실행에 대한 보다 세부적인 제어를 허용합니다. 예를 들어, 특정 테스트 스위트의 반복을 정의하고, 타임아웃을 제어하며, 테스트가 실패할 경우 재시도 메커니즘을 구성할 수 있어, 매우 사용자 정의가 가능한 테스트 환경을 제공합니다.
실패 처리 및 디버깅
API 테스트는 응답 형식 불일치부터 환경 설정 오류까지 수많은 이유로 실패할 수 있습니다. Postman CLI는 이러한 문제를 디버깅하는 데 필요한 상세 로깅을 지원합니다. --verbose 플래그를 사용하여 개발자는 요청 및 응답 본문, 헤더 및 실행 타이밍을 포함한 깊이 있는 정보를 액세스할 수 있습니다.
postman run --verbose
CI/CD 워크플로우에 통합될 때, 이러한 세부 사항은 매우 중요합니다. 상세 출력은 로그에 파이프되어, 개발자가 문제의 원인이 API 자체에 있는지, 테스트 구성에 있는지 또는 환경 설정에 있는지를 분석할 수 있습니다.
Apidog CLI 탐색: 자동화된 테스트를 위한 우수한 명령줄 경험
Postman CLI가 API 워크플로의 자동화로 잘 알려져 있는 반면, Apidog CLI 는 명령줄에서 API 시나리오 실행을 간소화하도록 특별히 구축된 견고하고 유연한 접근 방식을 제공하는 매력적인 대안입니다. Postman의 경쟁자인 Apidog은 개발자가 CI/CD 환경에서 복잡한 워크플로우를 자동화된 방식으로 신속하게 테스트할 수 있도록 맞춤화된 원활한 API 테스트 경험을 제공합니다.
왜 Apidog CLI인가?
Apidog의 CLI는 API 테스트 자동화에 필요한 모든 기능을 제공하며, 사용의 용이성, 고급 구성 옵션 및 강력한 통합 기능에 중점을 둡니다. 이를 통해 터미널에서 Apidog 테스트 시나리오를 실행할 수 있도록 설계되어, 개발 및 배포 워크플로우에 API 테스트를 직접 포함시키려는 팀에 이상적입니다. CLI는 Apidog의 강력한 클라우드 기능과 매끄럽게 통합되어, 여러 단계에서 API의 무결성에 대한 신속한 피드백을 보장합니다.
Apidog CLI 설정하기
Apidog CLI를 사용하려면, Node.js 버전 16 이상이 설치된 환경이 필요합니다. Apidog CLI는 npm을 통해 쉽게 설치할 수 있으며, 몇 개의 명령으로 빠르게 설정할 수 있습니다:
npm install -g apidog-cli
설치 후, 설정을 검증하는 것은 간단합니다. 아래 명령은 Node.js 버전, CLI 버전 및 Node, npm, Apidog의 설치 경로를 확인합니다:
node -v && apidog -v && which node && which npm && which apidog
이것은 시스템이 Apidog CLI를 사용하는 데 올바르게 구성되었는지 확인하고, 설정 문제를 해결하는 데에 도움이 됩니다.
Apidog CLI에서 테스트 시나리오 실행하기
Apidog CLI는 테스트 시나리오를 효율적으로 실행하도록 설계되어 있으며, 인증 및 테스트 실행 방식을 유연하게 선택할 수 있습니다. 테스트 시나리오는 고유한 ID로 지정하거나, 테스트 시나리오 컬렉션이 포함된 폴더를 참조하여 실행할 수 있습니다. 이 기능은 여러 환경과 구성에서 대규모 API 테스트를 실행하는 것을 간소화합니다.
다음은 Apidog 액세스 토큰을 사용하여 테스트 시나리오를 실행하는 예입니다:
apidog run --access-token <your-access-token> -t <test-scenario-id>
이 명령은 ID에 따라 테스트 시나리오를 실행하고, 액세스 토큰을 통해 인증 자격 증명을 안전하게 전달합니다. 특정 폴더의 모든 테스트 시나리오를 실행하려면, 폴더 ID를 사용하면 됩니다:
apidog run --access-token <your-access-token> -f <test-scenario-folder-id>
상세 사용자 정의를 위한 고급 CLI 옵션
Apidog CLI의 강점 중 하나는 고급 명령줄 옵션입니다. 테스트 보고서, 환경 변수, SSL 인증서를 구성할 수 있을 뿐만 아니라, 요청 간의 지연이나 타임아웃을 도입할 수 있습니다. Apidog는 단일 테스트 시나리오를 실행하든 다양한 환경에서 반복적으로 일괄 테스트를 실행하든 관계없이 테스트 프로세스에 대한 세밀한 제어를 제공합니다.
다음은 JSON 및 JUnit 형식으로 사용자 정의 보고서를 생성하고 특정 디렉토리에 저장하는 예입니다:
apidog run <collection> --reporters json,junit --out-dir ./test-reports
Apidog CLI를 사용하면 환경 변수를 동적으로 정의할 수도 있어, 테스트 시나리오가 맥락 민감해지고 API 구성의 변경에 맞게 조정 가능해집니다:
apidog run <collection> --env-var "BASE_URL=https://staging.api.com" --env-var "TOKEN=abc123"
이러한 유연성 덕분에 Apidog는 기존의 테스트 인프라와 매끄럽게 통합됩니다.
SSL 인증서 및 보안 테스트
오늘날 API를 테스트할 때 SSL 검증은 필수적입니다. Apidog CLI는 클라이언트 인증서를 전달하여 테스트 중 API와 안전한 연결을 허용합니다. 특정 도메인에 따라 단일 인증서 또는 여러 인증서를 사용하는 경우, Apidog는 이 과정을 단순화합니다. 테스트를 위해 단일 클라이언트 인증서를 지정할 수 있습니다:
apidog run <collection> --ssl-client-cert ./path/to/cert.pem --ssl-client-key ./path/to/key.pem
또는, 더 복잡한 설정을 위해 특정 URL과 일치하는 클라이언트 인증서 목록이 포함된 JSON 파일을 사용할 수 있습니다:
apidog run <collection> --ssl-client-cert-list ./path/to/ssl-cert-list.json
왜 Apidog로 전환해야 하는가?
Apidog CLI는 더 빠른 성능, 용이한 통합, 그리고 API 테스트 워크플로우에 대한 더 많은 제어를 찾고 있는 팀을 위한 향상된 경험을 제공합니다. 강력한 명령줄 도구의 유연성을 제공하면서 Apidog의 기능이 풍부한 플랫폼과 통합되어, Postman CLI의 강력한 대안이 됩니다.
Postman에 이미 익숙하다면, Apidog CLI로의 전환은 직관적으로 느껴지겠지만, Apidog가 제공하는 추가적인 유연성과 파워를 즉시 느낄 수 있을 것입니다. 풍부한 기능 세트와 광범위한 보고 및 동적 환경 관리 기능을 결합한 Apidog는 효율적이고 스케일러블한 API 테스트 솔루션이 필요한 개발자에게 강력한 선택지가 됩니다.
결론
결론적으로, Postman이 오랫동안 API 테스트 분야의 필수 요소였던 반면, Apidog의 CLI는 현대적이고 자동화된 워크플로우에 맞춰 개발된 강력한 대안을 제공합니다. 고급 명령 옵션, 원활한 환경 관리 및 유연한 보고 기능으로 Apidog CLI는 팀이 개발 및 배포의 다양한 단계에서 API를 효율적으로 테스트하고 검증할 수 있도록 합니다. CI/CD 파이프라인에 쉽게 통합할 수 있는 강력하고 유연한 도구를 찾고 있다면, Apidog CLI를 탐색할 가치가 있습니다. API 테스트에 대한 간소화된 접근 방식을 제공하여 API가 신뢰할 수 있고 안전하며 성능이 뛰어나도록 보장합니다.
