다단계 API 테스트¶

다단계 API 테스트는 여러 API 요청을 연결하여 복잡한 비즈니스 프로세스나 사용자 작업 경로를 시뮬레이션하는 고급 모니터링 도구입니다. 여러 API 연결의 응답 데이터를 사용하여 테스트를 생성함으로써 주요 비즈니스 트랜잭션을 검증하고, 엔드투엔드 사용자 여정을 시뮬레이션하며, 인증 및 권한 부여를 지원할 수 있습니다. 이러한 테스트 방식을 통해 서비스의 가용성과 성능을 능동적으로 모니터링하고, 복잡한 프로세스가 정상적으로 작동하는지 확인하며, 문제 발생 시 신속하게 알림을 보낼 수 있습니다.

생성 시작¶

작업 > 생성 > 다단계 API 테스트를 클릭합니다.

1. 기본 정보¶

1. API 테스트 작업 이름을 정의합니다.
2. 필요에 따라 설명을 입력합니다.

2. 테스트 노드 선택¶

현재 Guance는 전 세계 14개의 테스트 노드를 지원합니다. 중국 지역 또는 해외 지역(상용 플랜 이상 사용자만 해당)의 하나 이상의 노드를 선택하여 사이트 서비스 품질 모니터링을 빠르게 시작할 수 있습니다.

3. 테스트 빈도 선택¶

API 테스트 작업의 실행 빈도를 선택합니다. 다음 옵션을 지원합니다:

• 1분(상용 플랜 이상 사용자만 해당)
• 5분(상용 플랜 이상 사용자만 해당)
• 15분(상용 플랜 이상 사용자만 해당)
• 30분
• 1시간
• 6시간
• 12시간
• 24시간

시스템에서 제공하는 위의 특정 옵션 외에도 사용자 정의 crontab 작업을 입력하여 분, 시간, 일, 월, 주 등의 주기를 기반으로 예약된 작업 실행을 구성할 수 있습니다.

4. 요청 단계 정의¶

첫 번째 요청 생성을 클릭합니다.

이름¶

요청 이름을 정의합니다.

요청 형식 정의¶

1. 요청 URL을 정의합니다.
2. 필요에 따라 고급 설정을 수행합니다.

가용성 판단¶

기본 모드¶

판단 조건을 추가하여 API 테스트 결과의 성공 조건을 정의합니다.

여러 조건 간에 ‘모든 조건’ 또는 ‘임의 조건’을 선택하여 AND 또는 OR 논리 관계를 구현할 수 있습니다.

스크립트 모드¶

다단계 API 테스트 작업에서 스크립트 모드는 Pipeline 스크립트를 작성하여 다음과 같은 기능을 구현할 수 있습니다:

• 판단 조건 설정: 비즈니스 요구에 따라 복잡한 판단 로직을 사용자 정의하며, 단일 조건 또는 다중 조건 조합 판단을 지원합니다.
• 결과 데이터 처리: API 테스트 결과에 대한 사용자 정의 처리를 수행하며, 데이터 정리, 형식 변환 등을 포함합니다.
• 필드 추출 및 변수 정의: 응답에서 특정 필드를 추출하여 변수로 정의하고, 이후 단계에서 재사용할 수 있도록 합니다.

스크립트 모드는 응답에서 특정 필드를 추출하거나 복잡한 조건 판단을 수행하는 요구를 유연하게 충족할 수 있습니다.

예시:

body = load_json(response["body"])

if body["code"] == 200 {
  result["is_failed"] = false
  vars["token"] = body["token"]
} else {
  result["is_failed"] = true
  result["error_message"] = body["message"]
}

위 스크립트에서는 먼저 load_json을 사용하여 응답 내용을 JSON 객체로 파싱한 다음, 응답 상태 코드가 200인지 확인합니다. 200이면 응답 내용에서 token을 추출하여 vars를 통해 저장하고, 이후 요청에서 사용할 수 있도록 합니다. 그렇지 않으면 result의 is_failed를 true로 설정하고, error_message를 응답 내용의 message로 설정합니다.

더 자세한 내용은 사용자 정의 API 테스트 작업을 참조하세요.

지역 변수¶

현재 다단계 API 테스트 작업에서 정의된 지역 변수는 이후 요청 단계에서 참조할 수 있습니다.

1. 변수 이름을 입력합니다. 일반적으로 대문자, 숫자, 밑줄을 지원하며, 중복 이름은 허용되지 않습니다.
2. 변수 값을 선택합니다. 즉, 스크립트 모드에서 변수로 정의된 필드입니다.
3. 필요에 따라 변수 값 암호화 여부를 선택합니다. 선택하면 테스트 결과에서 현재 변수 값을 숨길 수 있습니다.

생성된 변수는 왼쪽 상단의 ‘변수’ 영역에 통합 표시됩니다.

요청 형식 정의 > 고급 설정 > 요청 헤더에서 지역 변수를 참조할 수 있습니다.

그림과 같이 단계 1에서 지역 변수 {{DS_ID}}가 정의되었으며, 그 값은 dashboard_id입니다. 요청 2에서 URL에서 직접 이 변수 값을 참조할 수 있습니다.

이러한 변수를 관리하려면 ‘지역 변수 구성’ 영역에서 오른쪽의 버튼을 클릭하여 편집 또는 삭제 작업을 수행할 수 있습니다.

실행 설정¶

‘이 단계가 실패하면 다음 단계를 계속 실행’을 선택하면 현재 단계가 실패할 때 오류를 건너뛰고 후속 단계를 계속 실행할 수 있습니다.

테스트¶

작업 단계 생성이 완료되면 ‘테스트’ 버튼을 클릭하여 테스트 결과를 빠르게 확인할 수 있습니다. 테스트 작업은 비동기적으로 실행됩니다. 실행이 완료되면 시스템은 다음 정보를 표시합니다:

• 테스트 성능: 테스트 과정의 성능 지표를 표시합니다.
• 응답 세부 정보: 문제 해결에 도움이 되는 자세한 응답 내용을 제공합니다.
• 변수: 현재 작업의 요청 및 URL에 구성된 변수를 확인할 수 있습니다.

첫 번째 요청 작업 이후의 단계부터 테스트를 시작하는 경우 현재 작업을 직접 테스트하거나 첫 번째 작업부터 테스트를 시작하도록 선택할 수 있습니다.

테스트가 실패하면 알 수 없는 변수가 있을 수 있습니다. ‘첫 번째 단계부터 현재 요청까지 테스트’ 버튼을 클릭하여 테스트를 다시 시작하여 문제를 해결할 수 있습니다.

요청 단계 계속 생성¶

첫 번째 단계의 API 테스트 작업을 생성한 후 ‘HTTP 요청 생성’ 또는 ‘대기 단계 생성’을 계속할 수 있습니다.

대기 단계¶

특정 시간 동안 대기한 후 다음 단계를 계속 실행합니다. 지속 시간은 1초, 5초, 15초, 30초, 1분, 2분 또는 3분 중에서 선택할 수 있습니다.

작업 관리¶

요청 단계 생성이 완료되면 저장을 클릭합니다.

생성된 작업에 대해 다음 작업을 통해 관리할 수 있습니다:

• 작업 왼쪽의 드래그 아이콘을 클릭하면 호출 단계 순서를 변경할 수 있습니다.
• 작업 오른쪽의 을 클릭하면 이 단계를 복제하거나 삭제할 수 있습니다.
• ‘일괄 작업’을 클릭하면 작업을 일괄 복제하거나 삭제할 수 있습니다.