EchoAPI 튜토리얼: EchoAPI에서 스크립트를 사용하는 방법

이 튜토리얼에서는 고급 API 테스트 및 개발을 위해 EchoAPI에서 스크립트를 활용하는 방법을 살펴보겠습니다. JavaScript로 작성된 EchoAPI 스크립트를 사용하면 API 요청에 동적 기능을 추가할 수 있습니다. 사전 실행 스크립트와 사후 실행 스크립트를 모두 이해함으로써 테스트 기능을 향상시키고, 변수를 관리하고, 요청 매개변수를 손쉽게 조작할 수 있습니다. EchoAPI 스크립트의 강력한 기능을 살펴보고 이를 통해 API 워크플로를 간소화할 수 있는 방법을 살펴보겠습니다.

EchoAPI 스크립트란 무엇입니까?

EchoAPI 스크립트는 API 요청 또는 수집 테스트 중에 동적 동작을 추가할 수 있는 JavaScript 기반 코드 조각입니다.

EchoAPI 스크립트의 기능

스크립트는 다음 기능을 수행할 수 있습니다.

• 요청 응답 결과(실행 후 스크립트)의 정확성을 테스트(어설션)합니다.
• API 서명 매개변수 추가(사전 실행 스크립트) 등 API 요청 매개변수를 동적으로 수정합니다.
• API 요청 간에 데이터를 전달합니다(스크립트의 변수 사용).
• 스크립트 내에서 API 엔드포인트에 직접 요청하세요.

EchoAPI 스크립트는 실행 전 스크립트와 실행 후 스크립트로 구분됩니다.

사전 실행 스크립트

요청이 전송되기 전에 사전 실행 스크립트가 실행됩니다.

사후 실행 스크립트

요청이 전송된 후 사후 실행 스크립트가 실행됩니다.

실제 제출 예

아래 다이어그램(콘솔 출력)에 표시된 것처럼 사전 실행 스크립트는 요청이 전송되기 전에 실행되고 사후 실행 스크립트는 요청이 완료된 후에 실행됩니다.

사전 실행 스크립트의 기능

사전 실행 스크립트에는 다음과 같은 몇 가지 주요 기능이 있습니다.

• JS 함수를 사용하여 복잡한 계산을 수행합니다.
• 변수 값을 인쇄합니다.
• 환경 변수를 정의, 검색, 삭제 및 지웁니다.
• 전역 변수를 정의, 검색, 삭제 및 지웁니다.
• 액세스 요청 매개변수.
• 헤더 매개변수를 동적으로 추가하거나 제거합니다.
• 쿼리 매개변수를 동적으로 추가하거나 제거합니다.
• 본체 매개변수를 동적으로 추가하거나 제거합니다.
• HTTP 요청을 보냅니다.

예를 들어 사전 실행 스크립트에서 _random 함수를 정의할 수 있습니다.

function _random() {
    return 'Hello, EchoAPI ' + Math.random();
}

이 함수는 "Hello, EchoAPI" 뒤에 임의의 숫자가 오는 문자열을 반환합니다. 그런 다음 다음과 같이 전역 변수 random_var에 할당할 수 있습니다.

pm.globals.set("random_var", _random());

사전 실행 스크립트에서 디버그 변수 인쇄

console.log()를 사용하여 필요한 변수를 콘솔에 인쇄하고 해당 변수의 현재 값을 볼 수 있습니다.

환경 변수 관리

• 환경 변수 설정:

  pm.variables.set("key", "value"); // Set an environment variable 'key' with value 'value'

• 환경 변수 검색:

  pm.variables.get("key"); // Get the value of the environment variable 'key'

• 환경 변수 삭제:

  pm.variables.delete("key"); // Delete the environment variable 'key'

• 모든 환경 변수 지우기:

  pm.variables.clear(); // Clear all defined environment variables

전역 변수 관리

• 전역 변수 설정:

  pm.globals.set("key", "value"); // Set a global variable 'key' with value 'value'

• 전역 변수 검색:

  pm.globals.get("key"); // Get the value of the global variable 'key'

• 전역 변수 삭제:

  pm.globals.delete("key"); // Delete the global variable 'key'

• 모든 전역 변수 지우기:

  pm.globals.clear(); // Clear all defined global variables

요청 매개변수에 액세스하기

요청 매개변수는 요청 개체를 통해 액세스할 수 있습니다. 자세한 내용은 "EchoAPI 내장 변수" 섹션을 참조하세요.

요청 매개변수를 동적으로 관리하기

• 헤더 매개변수 추가:

  pm.setRequestHeader("key", "value"); // Dynamically add a header parameter with key 'key' and value 'value'

• 헤더 매개변수 제거:

  pm.removeRequestHeader("key"); // Remove the header parameter with key 'key'

• 쿼리 매개변수 추가:

  pm.setRequestQuery("key", "value"); // Dynamically add a query parameter

• 쿼리 매개변수 제거:

  pm.removeRequestQuery("key"); // Remove the query parameter with key 'key'

• 본문 매개변수 추가:

  pm.setRequestBody("key", "value"); // Dynamically add a body parameter

• 본체 매개변수 제거:

  pm.removeRequestBody("key"); // Remove the body parameter with key 'key'

사전 실행 스크립트에서 HTTP 요청 보내기

사전 실행 스크립트에서 AJAX의 $.ajax() 메서드를 사용하여 HTTP 요청을 보낼 수 있습니다. 다음은 요청이 https://echo.apipost.cn/get.php로 전송되고 응답의 bigint가 전역 변수 bigint에 할당되는 간단한 예입니다.

function _random() {
    return 'Hello, EchoAPI ' + Math.random();
}

사후 실행 스크립트의 기능

사후 실행 스크립트는 요청이 전송된 후 실행되며 다음을 포함하여 사전 실행 스크립트와 동일한 여러 기능을 수행할 수 있습니다.

• JS 함수를 사용하여 복잡한 계산을 수행합니다.
• 변수 값을 인쇄합니다.
• 환경 변수를 정의, 검색, 삭제 및 지웁니다.
• 전역 변수를 정의, 검색, 삭제 및 지웁니다.
• 요청 및 응답 매개변수에 액세스합니다.
• HTTP 요청을 보냅니다.
• 요청 응답 결과의 정확성을 테스트(어설션)합니다.

환경 및 전역 변수를 정의, 검색, 삭제, 지우는 방법은 사전 실행 스크립트와 동일하므로 여기서는 반복하지 않습니다.

응답 매개변수 수신

응답 객체를 통해 응답 매개변수에 액세스할 수 있습니다. 자세한 동작은 "EchoAPI 내장 변수" 부분을 참고하세요.

요청 응답 유효성 테스트

사후 실행 스크립트를 사용하여 요청 응답 결과의 정확성을 테스트(어설션)할 수 있습니다.

결론

요약하자면 EchoAPI 스크립트는 API 테스트 및 개발 프로세스를 향상시키는 강력한 방법을 제공합니다. 사전 실행 및 사후 실행 스크립트를 모두 활용하면 요청 매개변수를 동적으로 관리하고, 응답 유효성을 확인하고, 변수를 효과적으로 활용할 수 있습니다. 이 기능은 테스트 프로세스를 간소화할 뿐만 아니라 더 복잡한 작업을 허용하므로 API 통합의 정확성과 효율성을 더 쉽게 보장할 수 있습니다. 지금 EchoAPI 스크립트 구현을 시작하고 API 테스트 경험을 향상시키세요!

위 내용은 EchoAPI 튜토리얼: EchoAPI에서 스크립트를 사용하는 방법의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!