Test-API

Test-API는 워크스페이스의 [API 연동] 메뉴에서 생성한 내용을 테스트 할 수 있습니다.

Test-API는 Business 플랜 이상에서 사용하실 수 있습니다.

[도입문의]

설명

Test-API는 디버거 페이지의 [상세 확인 탭] 영역에 위치해있습니다.

영역 번호	영역 이름	영역 설명
1	API/Module 선택	테스트 할 API와 Module을 선택하고 그에 대한 Event Config Key를 입력합니다.
2	ParamBlocks 입력	API 호출에 사용하는 ParamBlocks를 입력합니다. 이중배열 형태의 JSON 구문입니다.
3	Script 입력	API 호출에 사용하는 ParamBlocks의 전/후처리에 대한 스크립트를 작성합니다. 워크스페이스의 API연동 화면에서 저장된 경우 해당 스크립트를 불러옵니다.

API/Module 선택

(1)번의 API를 선택하고 (2)번의 Module을 선택한 후 [API 연동] 에서 정의한 Event Config Key를 (3)번에서 입력합니다.

ParamBlocks 입력

API 호출에 사용할 ParamBlocks를 입력하고 테스트 할 수 있습니다. 왼쪽 디버거에서 시나리오를 동작하고 출력된 로그창에서 ParamBlock을 복사하여 붙여넣으면 실제 동작한 시나리오상의 데이터(ParamBlocks)를 똑같이 테스트 할 수 있으며 임의로 ParamBlock의 특정값을 변경 후 결과값을 확인할 수 있습니다.

아래의 예시 그림은 2개의 ParamBlock을 복사하여 이중배열 형태의 JSON으로 작성한 모습입니다.

로그창에서 2개의 ParamBlock을 COPY하여 붙여넣은 예시

Script 입력

API를 요청하기 전 ParamBlocks를 변경하는 스크립트를 Param Script 에서 작성하여 API 호출 결과를 테스트 할 수 있습니다. 또한 API로부터 받은 응답 결과를 After Script에서 스크립트를 작성하여 결과 모습을 변경할 수 있습니다. Javascript로 작성하고 워크스페이스의 [API연동] 화면에서 스크립트를 저장하였다면 그 내용을 자동으로 불러옵니다.

활용

API 호출에 대한 테스트 결과값은 아래 1번의 로그창에서 확인할 수 있습니다. 2번의 좌측 버튼으로 Event Config Key 입력값을 모두 삭제하거나 우측 버튼으로 API 호출을 실행합니다.