외부 연동에 제공되는 External API, Open API 작성 가이드

“ LogicRepository Schema 사용 사례 위주 “

External API

외부 또는 레거시 시스템과 연동을 위해서 사용하는 API

external API는 자동 생성 API와 설정형 API를 사용할 수 있다.

자동 생성 API

...

외부 연동에 제공되는 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

• nodeType을 만들면 create, update, delete, list, read API를 기본적으로 사용 가능

설정 API

1. apiCategory 설정

• 속성 정의 : https://ionsdp.atlassian.net/wiki/spaces/ICE4P/pages/1048182809/apiCategory#API-Category-%EC%86%8D%EC%84%B1

• apiType : external

src/main/resources/schema/test/testExternalApi.json

...

• 속성정의 : api / apiConfig

  • apiType : external

  • method : POST, GET, PUT, DELETE, PATCH

  • parameters : 필수 request Parameter 설정을 할 수 있다.

...

{
  "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"
        }
      ]
    }
  ]
}

...

• 속성정의 : api / apiConfig

  • apiType : external

  • method : POST, GET, PUT, DELETE, PATCH

  • parameters : 필수 request Parameter 설정을 할 수 있다.

...

{
  "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

아래 사례는 sampleLogicMybatis logic형 NodeType의 “EVENT” API 설정이다.

- method : POST

- apiType : external

- parameter : title 필수

config 의 tid : sampleLogicMybatis schema에 선언된 event : testEvent 를 호출하여

(sampleLogicMybatisSchema에 미리 설정한 event : testEvent)

actionBody : sampleLogicMybatisService.testEventMethod 의 응답결과를 반환

...

{
    "timestamp": "2021-03-18T07:38:22.108+0000",
    "status": 400,
    "error": "Bad Request0000",
    "messagestatus": "Required String parameter 'apiKey' is not present"400,
    "patherror": "/api/testExternalApi/testList"
}

apiKey 발행

아래와 같이 해당 위치의 파일에 데이터를 작성하고 loadSchema하여 apiKey 생성하는 방식

src/main/resources/schema/core/api/apiKeyData.json

[
  {Bad Request",
    "typeIdmessage": "apiKey",Required String parameter 'apiKey' is "id": "W2!G*LgUu?5*!c*VubLVsfVyW42t$KHtnot present",
    "namepath": "SAMSUNG"
  }
]
/api/testExternalApi/testList"
}

apiKey 발행

POSTMAN Collection 참조

/postman/collection/Test API.postman_collection.json

• apiKey Create API로

...

• 생성

• 발행한 API 조회

설정 API

API를 설정하는 방식은 External API 의 설정방식과 동일하다.

apiType 만 open 으로 세팅하면 된다.

1. apiCategory 설정

• 속성 정의 : https://ionsdp.atlassian.net/wiki/spaces/ICE4P/pages/1048182809/apiCategory#API-Category-%EC%86%8D%EC%84%B1

• apiType : open

src/main/resources/schema/test/testOpenApi.json

...

• 속성정의 : api / apiConfig

  • apiType : open

{
  "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

{
  "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"
    }
  ]
}

...