カスタム コネクタ

このページでは、Integration Connectors のカスタム コネクタ機能の概要を説明し、次のコンセプトを理解していることを前提としています。

カスタム コネクタ機能を使用すると、Integration Connectors によって提供される標準コネクタの一部ではないコネクタを使用できます。たとえば、独自の接続プロトコルを備えた社内人事管理システム（HRMS）があり、コネクタを通してアプリケーションの統合に公開したいとします。 カスタム コネクタ機能は、次のようなシナリオで役立ちます。

  • 接続するデータソースやサービスの Integration Connectors では、組み込みコネクタは使用できません。
  • Integration Connectors で使用可能な組み込みコネクタですが、要件を満たしていません。

Integration Connectors はカスタム コネクタをどのようにサポートしていますか？

Integration Connectors は、Open API 仕様（バージョン 3.0.0 とそのすべてのマイナー バージョン）によりカスタム コネクタをサポートしています。バックエンドをパブリック エンドポイントとして公開し、エンドポイントの Open API 仕様を使用して、エンドポイント（バックエンド）に接続する新しいコネクタを作成できます。

エンドポイントの Open API 仕様では、Integration Connectors とエンドポイント間のコントラクトを定義します。 Integration Connectors は、API 仕様を使用してコネクタのアクションとエンティティを生成します。 API 仕様は JSON または YAML です。以下は、バックエンド サービスのサンプル Open API 仕様からの抜粋です。

{
"openapi":"3.0.2",
"info":{
	"title":"Swagger Petstore - OpenAPI 3.0",
	"description":"This is a sample Pet Store Server based on the OpenAPI 3.0 specification.
  You can find out more about\nSwagger at [
	http://swagger.io](http://swagger.io). In the third iteration of the pet store,
	we've switched to the design first approach!\nYou can now help us improve the API whether
  it's by making changes to the definition itself or to the code.\nThat way,
	with time, we can improve the API in general, and expose some of the new
  features in OAS3.\n\nSome useful links:\n-
  [
	   The Pet Store repository
	]
.....
.....
"paths":{
"/pet/{petId}/uploadImage":{
  "post":{
    "tags":[
},
.....
.....
"/pet/findByStatus":{
  "get":{
    "tags":[
      "pet"
    ],
.....
.....
},
"api_key":{
  "type":"apiKey",
  "name":"api_key",
  "in":"header"
}
}
}
}

サンプル仕様全体を表示するには、ペットストアのサンプル リポジトリをご覧ください。このサンプル仕様を使用してカスタム コネクタを作成すると、Integration Connectors は、path の要素ごとに個別のアクションを生成します。たとえば、uploadImage と findByStatus は、カスタム コネクタでサポートされているアクションとして一覧表示されます。

バックエンド接続のシナリオ

Integration Connectors は、次のバックエンド接続シナリオ用のカスタム コネクタをサポートしています。

  • バックエンドの直接接続
  • 間接的なバックエンド接続

シナリオ - バックエンドの直接接続

このシナリオでは、Integration Connectors ランタイムは、Open API 準拠のバックエンドへの接続を直接確立します。次の図は、このシナリオでのコネクタ接続を示しています。

バックエンドの直接接続

シナリオ - 間接的なバックエンド接続

このシナリオでは、Integration Connectors ランタイムは、Open API 準拠の中間（ファサード）サービスを介してバックエンドへの接続を確立します。次に、中間サービスがバックエンドに接続します。次の図は、このシナリオでのコネクタ接続を示しています。

間接的なバックエンド接続

次のステップ

カスタム コネクタを作成する方法を確認する。