API 설정은 API 호출에 대한 형식을 정의하며, 실제 API의 동작은 apiConfig로 정의한다.
...
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/{{apiType}}/{{apiCategory}}/{{api}} |
API는 다음과 같은 속성을 정의한다.
pid | valueType | description |
|---|---|---|
category(*) | REFERENCE | 상위 API 카테고리 지정 |
apiId(*) | STRING | API의 아이디이며 API URL의 마지막 path에 사용 |
apiName | STRING | API 명칭 |
method | CODE | API 호출 Method (POST, GET, PUT, DELETE, PATCH) |
apiType | CODE | API 유형 |
apiAuthority | REFERENCES | 권한 |
secure | BOOLEAN | SSL만 허용 여부 |
signed | BOOLEAN | 로그인된 사용자만 허용 여부 |
aggregation | BOOLEAN | 하나 이상의 apiConfig를 이용하여 여러 API를 조합하여 실행할지를 결정 |
statistic | BOOLEAN | 해당 API를 통계에 사용할지를 결정, false일 경우 API 로그에 7일만 보관되고 삭제 |
parameters | CHILDREN | 호출 파라미터 정의 |
root | PART | aggregation이 false인 경우 단독 apiConfig 설정 |
config | CHILDREN | aggregation이 true인 경우 다중 apiConfig 설정 |
...
| Code Block |
|---|
{
"result": "405",
"resultMessage": "허용하지 않는 Method 입니다."
} |
→ GET
| Code Block |
|---|
{
"time": "2020-10-21T08:45:32.321+0000",
"result": "200",
"resultMessage": "SUCCESS",
"item": {
"id": 1323881205,
"name": "[LG전자] X2 자급제폰(32GB)",
...
} |
...
하나 이상의 apiConfig를 이용하여 여러 API를 조합하여 실행할지를 결정
false 이면 root 설정 필수
true 이면 config 설정 필수
root
aggregation이 false인 경우 단독 apiConfig 설정
...