カスタムコネクタ

このページでは、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 に準拠した中間（ファサード）サービスを通じてバックエンドへの接続を確立します。次に、中間サービスがバックエンドに接続します。次の図は、このシナリオのコネクタ接続を示しています。