カスタム コネクタ
このページでは、Integration Connectors のカスタム コネクタ機能の概要について説明します。次のコンセプトを理解していることを前提としています。
カスタム コネクタ機能を使用すると、Integration Connectors が提供する標準コネクタの一部ではないコネクタを使用できます。たとえば、独自の接続プロトコルを備えた社内人事管理システム(HRMS)があり、コネクタを通して Application Integration に公開したいとします。カスタム コネクタ機能は、次のようなシナリオで役立ちます。
- 接続するデータソースまたはサービスに、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! You 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"
],
.....
.....
}
}
},
"components": {
"securitySchemes": {
"api_key":{
"type":"apiKey",
"name":"api_key",
"in":"header"
}
}
}
}
完全なサンプル仕様については、ペットショップのサンプル リポジトリをご覧ください。
このサンプル仕様を使用してカスタム コネクタを作成して、Integration Connectors が path の要素ごとに個別のアクションを生成するとします。たとえば、uploadImage と findByStatus は、カスタム コネクタでサポートされているアクションとして一覧表示されます。
バックエンド接続のシナリオ
Integration Connectors は、次のバックエンドへの接続シナリオのカスタム コネクタに対応しています。
- バックエンドの直接接続
- バックエンドの間接接続
シナリオ - バックエンドへの直接接続
このシナリオでは、Integration Connectors ランタイムが Open API 準拠のバックエンドへの接続を直接確立します。次の図は、このシナリオのコネクタ接続を示しています。
シナリオ - バックエンドの間接接続
このシナリオでは、Integration Connectors ランタイムは、Open API 準拠の中間(ファサード)サービスを介してバックエンドへの接続を確立します。次に、中間サービスがバックエンドに接続します。次の図は、このシナリオのコネクタ接続を示しています。
カスタム コネクタのバージョン
バージョニング機能を使用すると、カスタム コネクタの複数のバージョンを作成できます。各バージョンには、異なる OpenAPI 仕様、認証方法、バックエンド変数を使用できます。これにより、さまざまな構成でコネクタを作成できます。
新しいコネクタを作成すると、コネクタの最初のバージョンが自動的に作成され、バージョン詳細はカスタム コネクタの詳細ページの [バージョン] タブに表示されます。コネクタの新しいバージョンを作成する方法については、カスタム コネクタのバージョンを管理するをご覧ください。
次のステップ
カスタム コネクタを作成する方法を理解する。