apiCategory
- Hannah
- 조재호(Jerry)
Owned by Hannah
API 카테고리는 API를 그룹화 하여 관리하기 위해서 사용하며, 하위 API에 대한 공통 설정을 정의할 수 있다.
예를들어, API 카테고리에 권한을 설정하면, 하위 API는 모두 같은 해당 권한을 일차적으로 체크하게 된다.
{{protocol}}://{{hostname}}:{{port}}/{{apiType}}/{{apiCategory}}/{{api}}
API Category 속성
pid | valueType | description |
|---|---|---|
id | STRING | 생성할 apiCategory의 ID이며 API 호출 URL의 2번째 Path에 사용 |
categoryName | STRING | apiCategory의 이름 |
apiType | CODE | API 유형 |
apiAuthority | REFERENCES | 권한 |
dateFormat | STRING | dateFormat 설정(하위의 api에 공통으로 적용) |
fileUrlFormat | JSON | API에 리턴되는 file URL의 Prefix 설정(하위의 api에 공통으로 적용) |
commonParameters | CHILDREN | 공통 Parameter 정의(하위의 api에 공통으로 적용) "commonParameters": [
{
"parameter": "_siteId",
"required": true
},
{
"parameter": "_deviceType",
"required": false
}
] |
commonResponse | CHILDREN | 하위 API Config에서 사용할 기본 Response 정의 "commonResponse": [
{
"field": "time",
"type": "field",
"value": "{{:sysdate}}"
}
] |
apiType
apiAuthority
fileUrlFormat
API에 리턴되는 file URL의 Prefix 설정(하위의 api에 공통으로 적용)
"fileUrlFormat": {
"default": "{{:getEnvValue('core.cluster.api-url-prefix')}}"
},getEnvValue
Profile에 따라 환경 변수를 치환하여 결과를 반환한다.
커스텀 가능