5.2. OpenAPI 작업이 API 공급자 통합 흐름과 관련된 방법

API 공급자 통합의 OpenAPI 문서는 REST API 클라이언트가 호출할 수 있는 작업을 정의합니다. 각 OpenAPI 작업에는 자체 API 공급자 통합 흐름이 있습니다. 결과적으로 각 작업에는 자체 REST API 서비스 URL도 있을 수 있습니다. 각 URL은 API 서비스의 기본 URL에 의해 정의되며, 선택적으로 하위 경로에 의해 정의됩니다. REST API 호출은 해당 작업의 흐름 실행을 트리거하는 작업의 URL을 지정합니다.

OpenAPI 문서는 REST API 서비스 URL에 대한 호출에 지정할 수 있는 HTTP 동사(예: GET,POST,DELETE 등)를 결정합니다. API 공급자 URL에 대한 호출의 예는 API 공급자 빠른 시작 예제를 시도하는 방법에 있습니다.

또한 OpenAPI 문서에는 작업이 반환할 수 있는 가능한 HTTP 상태 코드가 결정됩니다. 작업의 반환 경로는 OpenAPI 문서에서 정의한 응답만 처리할 수 있습니다. 예를 들어 ID를 기반으로 오브젝트를 삭제하는 작업은 다음과 같은 가능한 응답을 정의할 수 있습니다. 

"responses": {
  "204": {
           "description": "Task deleted"
         },
  "404": {
           "description": "No Record found with this ID"
         },
  "500": {
            "description": "Server Error"
        }
}

API 공급자 통합 예

다음 다이어그램은 사용자에 대한 데이터를 처리하는 API 공급자 통합을 보여줍니다. 외부 REST API 클라이언트는 API 공급자 통합에서 배포한 REST API URL을 호출합니다. URL을 호출하면 하나의 REST 작업에 대한 흐름 실행이 트리거됩니다. 이 API 공급자 통합에는 3개의 흐름이 있습니다. 각 흐름은 Fuse Online에서 사용할 수 있는 모든 연결 또는 단계를 사용할 수 있습니다. REST API는 흐름과 함께 하나의 Fuse Online API 공급자 통합으로, 하나의 OpenShift Pod에 배포됩니다.

API provider integration with 3 flows

API 공급자 통합을 생성하는 동안 OpenAPI 문서 편집

API 공급자 통합을 위해 OpenAPI 문서를 지정한 후 API 작업에 대한 실행 흐름을 정의하는 동안 필요에 따라 문서를 업데이트할 수 있습니다. 이렇게 하려면 API 공급자 통합을 편집 중인 페이지의 오른쪽 상단에 있는 API 정의 보기/ 편집을 클릭합니다. 그러면 API Cryostat 편집기에 OpenAPI 문서가 표시됩니다. 문서를 편집하고 저장하여 Fuse Online에 반영된 내용을 변경합니다.

OpenAPI 문서를 편집하는 동안 고려 사항:

  • 동기화에 대한 operationId 속성

    API window 편집기의 OpenAPI 문서 버전과 Fuse Online 통합 편집기의 OpenAPI 문서 버전 간의 동기화는 문서에 정의된 각 작업에 할당된 고유한 operationId 속성에 따라 달라집니다. 각 작업에 특정 operationId 속성 값을 할당하거나 Fuse Online에서 자동으로 생성하는 작업을 사용할 수 있습니다.

  • 요청 및 응답 정의

    각 작업의 정의에서 작업의 요청 및 응답을 정의하는 JSON 스키마를 제공할 수 있습니다. Fuse Online에서는 JSON 스키마를 사용합니다.

    • 작업의 입력 및 출력 데이터 셰이프를 기반으로 합니다.
    • 데이터 매퍼의 작업 필드를 표시하려면 다음을 수행합니다.

  • 순환 스키마 참조 없음

    API 공급자 통합 작업의 JSON 스키마에는 사이클 스키마 참조가 있을 수 없습니다. 예를 들어 요청 또는 응답 본문을 지정하는 JSON 스키마는 전체로 참조하거나 중간 JSON 스키마를 통해 자체의 일부를 참조할 수 없습니다.