개요 - Apidog Docs

전처리기 및 후처리기는 Apidog의 핵심 기능입니다. 요청을 전송할 때 전처리기를 사용하여 요청을 동적으로 제어하거나, 후처리기를 사용하여 수신한 응답을 처리할 수 있습니다.

Apidog는 기존의 스크립트 기반 방식과 함께, 요청 전후 작업을 위한 시각적 드래그 앤 드롭 인터페이스를 제공합니다. 이 시각적 인터페이스를 통해 코드를 작성하지 않고도 일반적인 작업을 구성할 수 있으며, 고급 사용 사례를 위한 사용자 지정 스크립트도 계속 지원합니다.

빠른 시작

Apidog에서 전처리기 및 후처리기를 사용하는 단계는 다음과 같습니다.

아무 엔드포인트나 열고 Run 탭(Design-first Mode) 또는 Request 탭(Request-first mode)으로 이동하십시오.

Design-first Mode

Request-first Mode

Pre Processors 또는 Post Processors 섹션으로 전환한 다음, + Add 위에 마우스를 올리고 원하는 처리기를 선택하십시오.

추가한 처리기에 필요한 필드를 입력하십시오.

Send를 클릭하면 구성된 전처리기/후처리기와 함께 요청이 실행됩니다.

Design-first Mode에서는 Save as case를 클릭하여 요청을 저장하십시오. Request-first Mode에서는 Save 또는 Save as case를 클릭하여 요청을 저장하십시오.

Design-first Mode

Request-first Mode

TIP

독립 실행형 요청을 생성하고 해당 요청에 전처리기/후처리기를 적용할 수도 있습니다. 그러나 디버깅 및 테스트를 더욱 간소화하기 위해 엔드포인트 명세 위에서 전처리기/후처리기를 활용하는 것을 권장합니다.

기능

전처리기와 후처리기를 함께 사용하면 다양한 기능을 구현할 수 있습니다.

전처리기

요청 매개변수 설정: API 엔드포인트의 입력 데이터를 동적으로 정의합니다.

헤더 구성: Content-Type, Accept, Authorization과 같은 헤더를 지정합니다.

인증: 보호된 엔드포인트를 위해 토큰, API 키 또는 자격 증명을 추가합니다.

데이터베이스 통합: 요청 매개변수로 사용할 값을 데이터베이스에서 가져옵니다.

암호화: 전송 전에 요청 페이로드를 안전하게 보호합니다.

후처리기

어서션: 수신한 응답을 예상 결과(상태 코드, 본문 내용 등)와 비교하여 검증합니다.

변수 추출: 후속 요청에서 사용할 값을 응답에서 추출합니다.

데이터베이스 작업: 저장 또는 업데이트를 위해 응답 데이터를 데이터베이스에 기록합니다.

데이터 시각화: 응답 데이터의 보고서 또는 시각적 표현을 생성합니다.

TIP

일부 전처리 및 후처리 작업은 데이터베이스에 접근하거나, 외부 프로그램을 호출하거나, npm 패키지를 동적으로 로드할 때 보안 권한 부여 프롬프트를 트리거할 수 있습니다. Security 설정으로 이동하여 이러한 권한 부여 범위를 미리 구성할 수 있습니다.

사용 가능한 처리기

Apidog는 다음 전처리기/후처리기를 지원합니다.

처리기	유형	설명
Assertion	Post	응답 데이터를 예상 값(상태 코드, 본문, 헤더)과 비교하여 확인하는 검증 규칙을 정의합니다.
Extract Variable	Post	응답(JSON, XML, Text)에서 값을 추출하고 JSONPath 또는 XPath를 사용하여 변수로 저장합니다.
Database Operation	Pre/Post	SQL/NoSQL 데이터베이스에 연결하여 쿼리를 실행합니다. 결과는 변수로 저장할 수 있습니다.
Custom Scripts	Pre/Post	복잡한 로직을 처리하기 위해 사용자 지정 JavaScript 코드를 작성합니다. 요청/응답 데이터 및 환경 변수에 접근할 수 있습니다.
Public Scripts	Pre/Post	여러 처리기 또는 시나리오에서 공유되는 재사용 가능한 스크립트 조각을 생성합니다.
Wait	Pre/Post	요청 전후에 지연 시간을 도입하며, 실제 환경의 지연 시간을 시뮬레이션하는 데 유용합니다.

스크립트 작성을 간소화하려면 Apidog Script Generator 사용을 권장합니다. 자연어로 로직을 설명하면 생성기가 실행 가능한 스크립트를 생성해 줍니다.

실행 순서

전처리기 및 후처리기는 여러 수준에서 구성할 수 있습니다.

실행/엔드포인트 케이스 수준(기본값): 현재 실행/케이스에만 영향을 줍니다.

엔드포인트 수준: 엔드포인트와 연결된 모든 케이스에 적용됩니다.

폴더 수준: 폴더 내의 모든 엔드포인트에 영향을 줍니다.

프로젝트 수준: 프로젝트 내의 모든 요청에 적용됩니다(가장 높은 범위).

실행 흐름은 가장 높은 수준(프로젝트/폴더)에서 특정 실행/케이스 수준으로 내려갑니다.

실행 시각화

요청의 전처리기 집합은 다음과 같이 표시될 수 있습니다.

위 스크린샷에서:

처음 세 개의 처리기는 Inherit from parent 아래에 그룹화되어 있습니다. 이들은 루트 폴더, 특정 폴더(예: "Pets") 또는 엔드포인트 자체에 정의되어 있습니다.

이러한 상속된 처리기는 현재 실행에서 읽기 전용이지만 켜거나 끌 수 있습니다.

마지막 처리기는 이 실행을 위해 특별히 추가된 사용자 지정 스크립트이며 직접 편집할 수 있습니다.

변수 치환

Variable Substitution & Inherit from Parents라는 단계를 확인할 수 있습니다. 이 특수 전처리기는 {{variable}}과 같은 자리 표시자를 실제 값으로 대체합니다.

기본 동작: 대부분의 전처리기는 변수 치환 전에 실행됩니다.

치환 후 실행: 일부 스크립트(예: API 서명)는 변수가 대체된 후에 실행되어야 합니다. 이러한 처리기를 "Variable Substitution" 단계 아래로 수동으로 드래그할 수 있습니다.

전체 실행 흐름

단일 요청에 대한 자세한 실행 순서는 다음과 같습니다.

개요

빠른 시작#

기능#

전처리기#

후처리기#

사용 가능한 처리기#

실행 순서#

실행 시각화#

변수 치환#

전체 실행 흐름#