apiConfig는 실제 API 동작을 정의하는데 사용하며, configId 에 따라서 API Response 형태가 결정된다.
...
pid | valueType | description |
|---|
id | INT | 자동 생성 ID |
targetId | REFERENCE | 해당 API 설정 |
field | STRING | 응답 필드 명 |
type | CODE | 응답 필드 유형 all : 전체 응답 필드를 바이패스 position : 목록형일 경우 해당 응답의 순서 field : fieldId와 동일한 응답 항목 매핑 mapping : value에 정의한 값으로 매핑 config : 하위에 다른 API 결과를 조합하여 응답을 생성
|
value | STRING | 매핑 값, EL 사용 가능 |
config | CHILDREN | type이 config인 경우 하위 API Config 설정 |
response type
| Expand |
|---|
|
| Code Block |
|---|
{
"typeId": "api",
"category": "snack",
"apiId": "list",
"apiName": "snack List",
"apiType": "service",
"method": "GET",
"parameters": [
],
"statistic": true,
"aggregation": false,
"root": {
"configId": "root",
"tid": "snack",
"type": "query",
"query": [
{
"method": "matching",
"field": "name",
"value": "{{:name}}"
}
],
"response": [
{
"field": "_all_",
"type": "all"
}
]
}
} |
| Code Block |
|---|
{
"result": "200",
"resultMessage": "SUCCESS",
"totalCount": 1,
"totalTypeCount": 20,
"resultCount": 1,
"items": [
{
"id": "103",
"label": "오레오",
"name": "오레오"
}
]
} |
|
| Expand |
|---|
|
| Code Block |
|---|
{
"typeId": "api",
"category": "snack",
"apiId": "list",
"apiName": "snack List",
"apiType": "service",
"method": "GET",
"parameters": [
],
"statistic": true,
"aggregation": false,
"root": {
"configId": "root",
"tid": "snack",
"type": "query",
"query": [
{
"method": "matching",
"field": "name",
"value": "{{:name}}"
}
],
"response": [
{
"field": "id",
"type": "field",
"value": ""
}
]
}
} |
| Code Block |
|---|
{
"result": "200",
"resultMessage": "SUCCESS",
"totalCount": 1,
"totalTypeCount": 20,
"resultCount": 1,
"items": [
{
"id": "103"
}
]
} |
|
type별 사용 가능한 항목
| Query | Event | Select | Relay | Read | Reads | | Method | Process | Response |
|---|
id | | | | | | | | | | |
targetId | | | | | | | | | | |
configId | | | | | | | | | | |
type | | | | | | | | | | |
tid | O | O | | | O | O | O | | | |
resultType | | | | | | | | | | |
relayUrl | | | | O | | | | | | |
relayMethod | | | | O | | | | | | |
datasource | | | O | | | | | | | |
sql | | | O | | | | | | | |
method | | | | | | | | O | | |
process | | | | | | | | | O | |
cacheable | | | | | | | | | | |
cacheTime | | | | | | | | | | |
keepCache | | | | | | | | | | |
excludeCacheKey | | | | | | | | | | |
allowParams | | | | | | | | | | |
if | | | | | | | | | | |
connectTimeout | | | | | | | | | | |
readTimeout | | | | | | | | | | |
customFilter | O | | | | | | | | | |
customResponse | | | | | | | | | | |
event | | O | | | | | | | | |
failOver | | | | | | | | | | |
compensatingAPI | | | | | | | | | | |
query | O | | | | | | | | | |
data | | O | O | | O | O | | | | |
relayType | | | | O | | | | | | |
relayAuth | | | | O | | | | | | |
| | | | O | | | | | | |
bodyType | | | | O | | | | | | |
relayParameters | | | | O | | | | | | |
relayBody | | | | O | | | | | | |
response | | | | | | | | | | |
orderNo | | | | | | | | | | |