5장. REST API 호출에 의해 트리거되는 통합 생성

필요에 따라 통합 실행을 트리거하려면 사용자가 제공하는 REST API 설명 문서로 통합을 시작합니다. 이러한 방식으로 시작하는 통합을 API 공급자 통합 이라고 합니다. API 공급자 통합을 통해 REST API 클라이언트가 통합 실행을 트리거하는 명령을 호출할 수 있습니다.

Fuse Online에서 API 공급자 통합을 게시하면 통합 엔드포인트에 대한 네트워크 액세스 권한이 있는 모든 클라이언트에서 통합 실행을 트리거할 수 있습니다.

참고

OpenShift Container Platform 온사이트에서 Fuse Online을 사용하는 경우 관리자는 Fuse Online 서버를 구성하여 Red Hat 3scale API를 검색할 수 있습니다. 기본적으로 Fuse Online은 3scale과 함께 사용할 API 공급자 통합의 API 서비스 정의에 주석을 달지만 자동 3scale 검색을 위해 해당 API를 노출하지 않습니다. 3scale 검색이 없으면 액세스 제어가 없습니다. 3scale 검색을 사용하면 액세스 정책을 설정하고, 제어를 중앙 집중화하고, API 공급자 통합 API의 고가용성을 제공할 수 있습니다. 자세한 내용은 Red Hat 3scale 설명서 페이지에서 사용할 수 있는 API 게이트웨이 설명서를 참조하십시오.

API의 3scale 검색을 활성화하려면 Fuse Online 구성 도 참조하십시오.

다음 주제에서는 API 공급자 통합을 생성하기 위한 정보와 지침을 제공합니다.

API 공급자 통합을 생성, 게시 및 테스트하는 방법을 보여주는 동영상은 https://youtu.be/sox8SSqJ0zQ 을 참조하십시오.

5.1. API 공급자 통합을 생성하기 위한 이점, 개요 및 워크플로우

API 공급자 통합은 REST API 서비스로 시작됩니다. 이 REST API 서비스는 API 공급자 통합을 생성할 때 제공하는 OpenAPI 3(또는 2) 문서에 의해 정의됩니다. API 공급자 통합을 게시한 후 Fuse Online은 OpenShift에 REST API 서비스를 배포합니다. API 공급자 통합의 이점은 REST API 클라이언트가 통합 실행을 트리거하는 호출을 호출할 수 있다는 점입니다.

여러 실행 흐름

API 공급자 통합에는 흐름이라는 여러 실행 경로가 있습니다. OpenAPI 문서에서 정의하는 각 작업에는 자체 흐름이 있습니다. Fuse Online에서는 OpenAPI 문서에서 정의한 각 작업에 대해 해당 작업의 실행 흐름에 연결 및 기타 단계를 추가합니다. 이러한 단계는 특정 작업에 필요한 대로 데이터를 처리합니다.

실행 흐름 예

예를 들어 Fuse Online에서 사용할 수 있는 REST API 서비스를 호출하는 인적 리소스 애플리케이션을 고려해 보십시오. 호출이 새 작업자를 추가하는 작업을 호출한다고 가정합니다. 이 호출을 처리하는 작업 흐름은 다음을 수행할 수 있습니다.

  • 새 직원 장비에 대한 비용 보고서를 생성하는 애플리케이션에 연결합니다.
  • SQL 데이터베이스에 연결하여 새 장비 설정을 위한 내부 티켓을 추가합니다.
  • Google 메일에 연결하여 방향 정보를 제공하는 새 직원에게 메시지를 보냅니다.

실행을 트리거하는 방법

다음을 포함하여 통합 실행을 트리거하는 REST API를 호출하는 방법에는 여러 가지가 있습니다.

  • 데이터 입력을 사용하고 호출을 생성하는 웹 브라우저 페이지입니다.
  • curl 유틸리티와 같이 REST API를 명시적으로 호출하는 애플리케이션입니다.
  • REST API를 호출하는 기타 API(예: Webhook)

흐름을 편집하는 방법

각 작업에 대해 다음을 통해 해당 흐름을 편집할 수 있습니다.

  • 데이터를 처리해야 하는 애플리케이션에 대한 연결 추가.
  • 분할, 집계 및 데이터 매핑 단계를 포함한 연결 간 단계 추가
  • 연결 오류 메시지를 매핑하여 HTTP 응답의 코드를 반환하여 흐름을 완료합니다. 응답은 통합 실행을 트리거한 호출을 호출한 애플리케이션으로 이동합니다.

API 공급자 통합을 생성하기 위한 워크플로우

API 공급자 통합을 생성하기 위한 일반 워크플로우는 다음 다이어그램에 표시되어 있습니다.

General workflow for creating an API provider integration

API 공급자 통합 게시

API 공급자 통합을 게시한 후 통합 요약 페이지에서 Fuse Online에 REST API 서비스의 외부 URL이 표시됩니다. 이 외부 URL은 클라이언트가 REST API 서비스를 호출하는 데 사용하는 기본 URL입니다.

OCP의 Fuse Online 환경의 경우 API 공급자 통합에 대한 Red Hat 3scale 검색이 활성화될 수 있습니다. 이 경우 3scale은 서비스 호출을 위한 URL을 게시합니다.

API 공급자 통합 테스트

API 공급자 통합의 흐름을 테스트하기 위해 curl 유틸리티를 사용하면 됩니다. 예를 들어 다음 curl 명령은 REST API 서비스 URL에 대한 ID 작업으로 Get Task 의 흐름 실행을 트리거합니다. https://i-task-api-proj319352.6a63.fuse-ignite.openshiftapps.com/api/.

HTTP GET 명령은 기본 요청이므로 GET 을 지정할 필요가 없습니다. URL의 마지막 부분은 가져올 작업의 ID를 지정합니다. 

curl -k https://i-task-api-proj319352.6a63.fuse-ignite.openshiftapps.com/api/todo/1