API 카테고리는 API를 그룹화 하여 관리하기 위해서 사용하며, 하위 API에 대한 공통 설정을 정의할 수 있다.
...
Info |
---|
{{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에 공통으로 적용) yyyy-MM-dd HH:mm:ss |
fileUrlFormat | JSON | API에 리턴되는 file URL의 Prefix 설정(하위의 api에 공통으로 적용) |
commonParameters | CHILDREN | 공통 Parameter 정의(하위의 api에 공통으로 적용) Code Block |
---|
"commonParameters": [
{
"parameter": "_siteId",
"required": true
},
{
"parameter": "_deviceType",
"required": false
}
] |
|
commonResponse | CHILDREN | 하위 API Config에서 사용할 기본 Response 정의 Code Block |
---|
"commonResponse": [
{
"field": "time",
"type": "field",
"value": "{{:sysdate}}"
}
] |
|
apiType
Include Page |
---|
| ~675130055:apiType~675130055: |
---|
| apiType |
---|
|
|
apiAuthority
fileUrlFormat
...
Expand |
---|
apiCategory Code Block |
---|
| "fileUrlFormat": {
"default": "{{:getEnvValue(core.cluster.api-url-prefix, url)}}",
"video": "{{:getEnvValue(core.cluster.wowza-url-prefix, url)}}"
} |
application.yml Code Block |
---|
| core:
project: sbdc
internal-port: 8080
session-timeout: 30m
single-http-connector: true
cluster:
api-url-prefix: http://dev-core.justten.io/
front-url-prefix: http://dev-builder.justten.io/
wowza-url-prefix: https://vod.justten.io/vod_stg/_definst_/%s/playlist.m3u8
mode: all
default-service-group: all
members: 192.1.1.110 |
propertyType.json Code Block |
---|
| {
"pid": "fileValue",
"name": "파일",
"valueType": "FILE",
"required": true,
"idable": false,
"labelable": true,
"treeable": false,
"indexable": true,
"analyzer": "simple",
"fileHandler": "video",
"referenceType": "",
"referenceValue": "",
"orderNo": 30
} |
VideoFileRepository.java API Response : mainImageFile 는 default fileHandler
fileValue 는 video fileHandler
Code Block |
---|
| {
"mainImageFile": "http://dev-core.justten.io/imageResource/fileValue/202007/17/48195194-c6e5-4a86-a7e4-a3e61b777032.png",
"fileValue": "https://vod.justten.io/vod/_definst_/videoResource/fileValue/202003/25/21c90041-95eb-406f-8a2b-5e15ef4bc6dd.mp4/playlist.m3u8"
} |
|
...