Apidog는 백엔드, 프론트엔드 및 QA 팀이 더욱 효율적으로 협업하고 개발할 수 있도록 돕는 API 협업 및 개발 플랫폼입니다. QA 엔지니어를 위해 Apidog는 유닛 테스트, 통합 테스트, 데이터 기반 테스트, 성능 테스트, 회귀 테스트, CI/CD 및 예약 모니터링을 포함한 다양한 테스트 기능을 제공합니다.
기본부터 시작하여 Apidog를 사용하는 QA 엔지니어를 위한 전체 워크플로우를 살펴보겠습니다.
초기 준비
API 테스트를 시작하기 위한 첫 번째 단계는 상세한 API 문서를 얻는 것입니다. Apidog는 기존 API 문서를 직접 가져올 수 있게 함으로써 이를 용이하게 만들어줍니다. 이를 통해 각 엔드포인트를 수동으로 입력할 필요가 없습니다. Project Settings -> Import Data로 이동하여 적절한 데이터 형식을 선택하여 가져오면 됩니다.
단위 테스트
단위 테스트는 테스트 프로세스의 중요한 부분입니다. 이는 각 API가 다양한 조건에서 기대한 대로 작동하는지 확인합니다. QA 엔지니어는 정상, 예외 및 경계 사례와 같은 다양한 시나리오를 포괄하는 상세한 테스트 케이스를 작성합니다. 이는 API가 모든 가능한 입력을 처리하도록 보장합니다.
예를 들어, "Query Pet Details" 엔드포인트는 애완동물의 세부 정보를 검색하기 위해 매개변수로 애완동물 ID가 필요합니다. QA 엔지니어는 Apidog의 "Run" 페이지에 petId=123을 입력하고 요청을 보낼 수 있습니다. 그런 다음 올바른 애완동물 세부 정보가 반환되는지 확인할 수 있습니다.
테스트를 자동화하기 위해 후처리기에서 주장을 추가할 수 있습니다. 이러한 주장은 data 필드 아래에서 올바른 애완동물 ID가 응답에 나타나는지 확인합니다. JSONPath 표현식 $.data.id를 사용하여 주장을 Exists로 설정하면 애완동물 ID를 자동으로 추출하고 검증할 수 있습니다.
응답에서 주장을 직접 추출할 수도 있습니다.
이 단계가 완료되면 테스트 케이스를 저장할 수 있습니다. "Pets Available for Sale", "Pets Sold", "Record Not Found", "Incorrect ID Format"와 같은 추가 정상 및 비정상 테스트 케이스를 필요에 따라 생성할 수 있습니다. 이러한 저장된 테스트 케이스는 향후 회귀 테스트에서 신속하고 쉽게 실행하여 핵심 기능의 안정성을 확인할 수 있습니다.
통합 테스트
개별 API를 테스트하는 것도 중요하지만, 실제 애플리케이션은 여러 API가 함께 작동해야 할 때가 많습니다. 통합 테스트는 이러한 API들이 올바르게 상호작용하는지 확인합니다. 이는 실제 사용자 행동을 시뮬레이션하고 API 간의 데이터 교환 및 워크플로를 테스트합니다.
예를 들어, 애완동물 구매 과정에서 사용자는 애완동물 목록을 탐색하고, 애완동물을 장바구니에 추가하고, 주문을 하고, 결제를 하고, 주문 세부 정보를 볼 수 있습니다. QA 엔지니어는 Apidog에서 테스트 시나리오를 생성하여 이 과정에 포함된 각 엔드포인트에 대한 테스트 케이스를 추가할 수 있습니다.
엔드포인트 간의 데이터 전송는 테스트 프로세스가 완전하도록 보장하는 데 중요합니다. 애완동물 구매 흐름을 예로 들면, QA 엔지니어는 두 가지 방법으로 주문 ID를 단계 간에 전달할 수 있습니다:
- 방법 1: "Create Order" 엔드포인트를 실행한 후 생성된 주문 ID를 변수로 저장하고 후속 결제 및 주문 조회 엔드포인트에서 사용합니다.
- 방법 2: 결제 및 주문 조회 엔드포인트에서 "Create Order" 엔드포인트의 반환 값을 직접 사용합니다(이 방법이 더 쉽고 권장됩니다).
여러 애완동물을 장바구니에 추가하는 것과 같은 배치 작업을 위해 ForEach 루프를 추가할 수 있습니다. 루프 배열을 애완동물 목록으로 설정하세요.
그러면 애완동물 ID가 자동으로 삽입되어 대량 작업이 더욱 수월해집니다.
모든 설정을 마친 후 테스트 시나리오를 실행하세요. 그러면 상세한 테스트 보고서가 생성됩니다. QA 엔지니어는 그 후 문제를 신속하게 찾아 수정할 수 있습니다.
데이터 기반 테스트
일부 경우, 동일한 엔드포인트를 여러 데이터 세트로 테스트해야 할 필요가 있습니다. Apidog의 데이터 기반 테스트 기능은 이를 돕습니다. QA 엔지니어는 다양한 데이터 세트를 포함하는 CSV 파일을 가져올 수 있습니다. 이렇게 가져온 세트는 테스트 시나리오에서 자동으로 테스트를 실행하는 데 사용될 수 있습니다.
작동 방식은 다음과 같습니다: QA 엔지니어는 새로운 테스트 시나리오를 만들고 "Create Pet Information" 엔드포인트를 추가한 다음, Test Data에 CSV 파일을 가져옵니다. CSV 파일의 각 행(첫 번째 행은 변수 이름)은 API 요청에 사용할 수 있는 데이터 세트를 나타냅니다.
CSV 파일의 데이터를 매핑하기 위해 엔드포인트 요청의 JSON 본문에서 이러한 변수를 참조합니다.
적절한 테스트 데이터와 환경을 선택한 후 테스트를 실행하면, Apidog는 각 데이터 세트에 대해 엔드포인트 케이스를 자동으로 실행하고 모든 라운드에 대한 실행 상태 및 보고서를 생성합니다.
이러한 방식으로 대량 테스트를 자동화함으로써 Apidog는 테스트 프로세스의 효율성과 정확성을 크게 향상시킵니다.
성능 테스트
엔드포인트의 기본 기능이 검증되면 다음 단계는 성능 테스트입니다. 이는 시스템이 트래픽이 많은 상황에서 어떻게 작동하는지를 확인합니다. Apidog는 여러 가상 사용자를 시뮬레이션하여 시스템의 응답을 테스트하는 성능 테스트 도구를 제공합니다.
예를 들어, 주문 시나리오에서 QA 엔지니어는 가상 사용자 수(예: 10), 테스트 지속 시간 및 증가 시간을 설정할 수 있습니다(예: 1분). 테스트 중에 Apidog는 초당 요청 수, 서버 응답 시간 및 오류 비율과 같은 주요 지표를 보여주는 실시간 차트를 생성합니다. 이는 QA 엔지니어가 성능 병목 현상을 식별하고 최적화하는 데 도움을 줍니다.
회귀 테스트
시스템이 발전함에 따라 새로운 기능이 기존 기능에 영향을 줄 수 있습니다. 회귀 테스트는 새로운 업데이트가 핵심 기능을 망치지 않도록 보장합니다. Apidog에서는 QA 엔지니어가 회귀 테스트 폴더를 생성하고 주요 테스트 시나리오를 추가할 수 있습니다. 각 릴리스 전에 이러한 테스트를 일괄 실행하여 모든 것이 예상대로 작동하는지 확인할 수 있습니다.
CI/CD 통합
현대 개발 워크플로에서는 지속적 통합(CI) 및 지속적 배포(CD)가 빠른 릴리스 주기와 고품질 코드를 유지하는 데 필수적입니다. Apidog는 Jenkins와 같은 CI/CD 도구와 원활하게 통합되어 자동화된 테스트를 빌드 파이프라인의 일부로 실행할 수 있습니다.
QA 엔지니어는 특정 테스트 시나리오의 CI/CD 페이지로 이동하여 적절한 환경과 테스트 데이터를 선택하고 테스트 결과에 대한 알림을 활성화할 수 있습니다(이메일, Slack, Webhook, Jenkins 등 다양한 알림 방법을 지원). 그런 다음 해당 CI/CD 도구를 선택하고 생성된 명령을 복사하여 Jenkins 또는 다른 빌드 도구에 구성합니다.
통합 과정에서 Access Token을 생성하고 구성하는 것이 중요하여 Jenkins와 원활하게 인증하고 통신할 수 있도록 합니다. 구성한 후 Apidog는 빌드가 트리거될 때마다 자동으로 테스트를 실행하고 선택된 알림 방법을 통해 팀에 테스트 결과를 전송하여 협업 효율성을 높입니다.
API 테스트를 위한 예약 작업
때때로 시스템의 안정성을 보장하기 위해 정기적으로 테스트를 실행해야 할 필요가 있습니다. Apidog의 예약 작업 기능은 QA 엔지니어가 이 프로세스를 자동화할 수 있도록 합니다. 특정 시간에 테스트를 실행하고 결과에 대한 알림을 받을 수 있도록 설정할 수 있습니다.
이 기능을 사용하기 전에 QA 엔지니어는 서버에 Apidog의 Runner를 설치해야 합니다. 이렇게 하면 예약 작업이 로컬 컴퓨터가 켜져 있지 않아도 서버에서 독립적으로 실행될 수 있습니다. 설치 후 QA 엔지니어는 새로운 예약 작업을 만들고 테스트 시나리오를 선택한 다음 실행 모드와 서버를 설정하고 알림을 활성화할 수 있습니다.
작업이 실행된 후 Apidog는 결과를 기록하고 팀에 전송하여 문제를 신속하게 찾아 수정할 수 있도록 도와줍니다.
최종 요약
Apidog는 초기 준비부터 지속적인 모니터링까지 API 테스트 수명 주기를 크게 간소화하는 포괄적인 기능 세트를 제공합니다. 유닛, 통합, 데이터 기반, 성능, 회귀 및 CI/CD 테스트와 같은 강력한 기능을 갖춘 Apidog는 효율적이고, 신뢰할 수 있으며, 확장 가능한 API 테스트를 보장합니다. Apidog를 테스트 워크플로에 통합함으로써 팀은 시간을 절약하고 오류를 줄이며 고품질 API를 더 빠르게 제공하여 시스템의 안정성과 성능을 향상시킬 수 있습니다.
