FlexAPI는 자주 사용하는 API를 정의하고 호출할 수 있도록 도와주는 기능입니다.
현재 워크스페이스에서 사용 중인 API 종류를 표시합니다. "새 API" 버튼을 통해 새로운 API를 추가할 수 있습니다.
API의 명칭을 수정할 수 있는 영역입니다. API의 ID 값을 확인할 수 있으며, 이 API 명칭이 스튜디오에서 서비스를 추가할 때의 시스템명이 됩니다.
현재 선택한 API에 등록된 API 모듈 리스트를 표시합니다. "새 모듈" 버튼을 통해 API에 새 모듈을 추가할 수 있습니다.
해당 영역에서 모듈로 호출할 FlexAPI 내용을 구성할 수 있습니다.
| 항목명 | 설명 |
|---|---|
| Module 명 | 모듈 이름 (이 모듈명이 스튜디오에서 서비스를 추가할 때의 모듈명이 됩니다.) |
| Event Config Key | 스튜디오에서 동적으로 값을 받아올 수 있는 키를 지정합니다. |
| 여러 개의 값을 입력할 때는 세미콜론(;)으로 구분합니다 (예: a;b;c) | |
| URL | 호출할 API 주소 |
| Header | API 호출 시 사용할 헤더를 정의합니다. (필수, 값이 없는 경우 {}로 추가해줍니다.) |
| HTTP Method | 호출 방식 정의 선택 (GET, POST, PUT, PATCH, DELETE) |
| Request Body | API 호출 시 전달할 바디(body)를 정의합니다. 시나리오에서 전달 받은 데이터는 ParamBlocks를 통해 접근가능합니다. 이때 ParamBlocks는 별도의 전처리가 없을 경우 이중배열형태입니다. |
| Response Body | API 호출 후 시나리오로 전달할 데이터를 정의합니다. 이 데이터는 Result를 통해 접근 가능합니다. |
| Error Message | API 호출 후 오류가 발생할 경우 전달할 데이터를 정의합니다. 이 데이터는 Result로 접근 가능합니다. |