외부 연동에 제공되는 External API, Open API 작성 가이드
“ LogicRepository Schema 사용 사례 위주 “
“아래 모든 Sample API에 대하여 POSTMAN Test API Collection 에 정의해두었습니다.
POSTMAN에서 import하여 참조해주세요.”
- backendcore : postman/collection/Test API.postman_collection.json
External API
외부 또는 레거시 시스템과 연동을 위해서 사용하는 API
external API는 자동 생성 API와 설정형 API를 사용할 수 있다.
자동 생성 API
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/ext/{{nodeType}}/{{event}} |
nodeType을 만들면 create, update, delete, list, read API를 기본적으로 사용 가능
| Expand | ||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| ||||||||||||||||||||||||||||||
|
설정 API
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/ext/{{apiCategory}}/{{api}} |
1. apiCategory 설정
apiType : external
src/main/resources/schema/test/testExternalApi.json
...
apiType : external
method : POST, GET, PUT, DELETE, PATCH
parameters : 필수 request Parameter 설정을 할 수 있다.
...
| Code Block |
|---|
{
"typeId": "api",
"category": "testExternalApi",
"apiId": "testList",
"apiName": "test LIST API (Sample External)",
"method": "GET",
"apiType": "external",
"parameters": [
{
"parameter": "title",
"name": "Title",
"valueType": "STRING",
"required": true
},
{
"parameter": "price",
"name": "Price",
"valueType": "NUMBER",
"required": false
}
],
"statistic": true,
"aggregation": falsetrue,
"config": [
{
"configId": "root",
"tid": "sampleLogicMybatis",
"type": "query",
"allowParams": false,
"orderNo": 1,
"response": [
{
"field": "all",
"type": "all"
}
]
}
]
} |
...
apiType : external
method : POST, GET, PUT, DELETE, PATCH
parameters : 필수 request Parameter 설정을 할 수 있다.
...
| Code Block |
|---|
{
"typeId": "api",
"category": "testExternalApi",
"apiId": "testRead",
"apiName": "test READ API (Sample External)",
"method": "GET",
"apiType": "external",
"parameters": [
{
"parameter": "id",
"name": "ID",
"valueType": "NUMBER",
"required": true
}
],
"statistic": true,
"aggregation": falsetrue,
"config": [
{
"configId": "root",
"tid": "sampleLogicMybatis",
"type": "read",
"resultType": "OBJECT",
"allowParams": false,
"orderNo": 1,
"response": [
{
"field": "all",
"type": "all"
}
]
}
]
} |
...
속성정의 : api / apiConfig / type : event
apiType : external
아래 사례는
sampleLogicMybatislogic형 NodeType의 “EVENT” API 설정이다.- method : POST
- apiType : external
- parameter : title 필수
config 의
tid : sampleLogicMybatisschema에 선언된event : testEvent를 호출하여(
sampleLogicMybatisSchema에 미리 설정한event : testEvent)
actionBody : sampleLogicMybatisService.testEventMethod의 응답결과를 반환
...
| Status | ||||
|---|---|---|---|---|
|
설정 API
| Info |
|---|
{{protocol}}://{{hostname}}:{{port}}/api/{{apiCategory}}/{{api}}?apiKey=XXXXXX |
API를 설정하는 방식은 External API 의 설정방식과 동일하다.
apiType 만 open 으로 세팅하면 된다.
1. apiCategory 설정
apiType : open
src/main/resources/schema/test/testOpenApi.json
...
| Code Block |
|---|
{
"typeId": "api",
"category": "testOpenApi",
"apiId": "testList",
"apiName": "test LIST API (Sample Open)",
"method": "GET",
"apiType": "open",
"parameters": [
{
"parameter": "title",
"name": "Title",
"valueType": "STRING",
"required": true
},
{
"parameter": "price",
"name": "Price",
"valueType": "NUMBER",
"required": false
}
],
"statistic": true,
"aggregation": falsetrue,
"config": [
{
"configId": "root",
"tid": "sampleLogicMybatis",
"type": "query",
"allowParams": false,
"orderNo": 1,
"response": [
{
"field": "all",
"type": "all"
}
]
}
]
} |
...
속성정의 : api / apiConfig / type : event
apiType : open
| Code Block |
|---|
{
"typeId": "api",
"category": "testOpenApi",
"apiId": "testEvent",
"apiName": "testEvent API (Sample Open)",
"method": "POST",
"apiType": "open",
"parameters": [
{
"parameter": "title",
"name": "Title",
"valueType": "STRING",
"required": true
},
{
"parameter": "price",
"name": "Price",
"valueType": "NUMBER",
"required": false
}
],
"statistic": true,
"aggregation": true,
"config": [
{
"configId": "root",
"tid": "sampleLogicMybatis",
"type": "event",
"allowParams": false,
"orderNo": 1,
"event": "testEvent"
}
]
} |
...