설정 API는 Platform Console의 API 설정 기능이나 스키마의 API 설정 Json 파일을 이용하여 정의한 API로 FrontOffice와 외부 인터페이스에 사용된다.
API 설정 정보의 구조는 다음과 같다.
apiCategory
하위에 N개의 api를 구성
하위 api에 대한 공통 설정을 정의 (권한, 파일포멧 등..)
api
API 호출에 대한 형식을 정의
하나의 API는 여러개의 API Config를 설정함으로써 API GW의 Aggregation 기능을 제공
apiConfig
API 동작을 정의
Type
Query
Event
Select
Relay
Read
Form
Reads
Method
Process
Response
API 호출 패턴
설정 API는 아래 형태로 호출할 수 있다.
Info |
---|
{{protocol}}://{{hostname}}:{{port}}/{{apiTypePath}/{{apiCategory}}/{{api}} |
ApiType
...