カスタム コネクタと接続を作成する
このページでは、ウェブサービスの OpenAPI 仕様を作成し、カスタム コネクタとこのコネクタの接続を作成する方法について説明します。
カスタム コネクタを作成する前に、ウェブサービスの OpenAPI 仕様を作成する必要があります。
ウェブサービスの OpenAPI 仕様を作成する
カスタム コネクタは OpenAPI 3.0 をサポートしています。仕様を手動で作成することもできます。OpenAPI 仕様については、OpenAPI 仕様をご覧ください。
gin swagger ミドルウェアを使用して OpenAPI 2.0 仕様を自動生成することもできます。詳細については、Gin Swagger をご覧ください。Swagger Converter を使用して、OpenAPI 2.0 仕様を OpenAPI v3.0 仕様に変換する必要があります。
OpenAPI 仕様のサンプル。
{ "openapi": "3.0.0", "info": { "title": "Go HTTPbin Proxy Service", "description": "A simple Go service that proxies requests to httpbin.org, adding custom headers.", "version": "1.0.0" }, "servers": [ { "url": "http://localhost:8080" } ], "paths": { "/getData": { "get": { "summary": "Fetch data from httpbin.org/get", "description": "Sends a GET request to httpbin.org/get, including any custom headers.", "responses": { "200": { "description": "Successful response from httpbin.org", "content": { "application/json": { "schema": { "type": "object" } } } } } } }, "/postData/{id}": { "post": { "summary": "Post data to httpbin.org/post", "description": "Sends a POST request to httpbin.org/post with data, including any custom headers.", "parameters": [ { "in": "path", "name": "id", "required": true, "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "name": { "type": "string" }, "address": { "type": "string" }, "gender": { "type": "string" } }, "required": [ "name", "address", "gender" ] } } } }, "responses": { "200": { "description": "Successful response from httpbin.org", "content": { "application/json": { "schema": { "type": "object" } } } }, "400": { "description": "Bad Request - Invalid request body" } } } } } }
カスタム コネクタを作成し、サービスを検証する
カスタム コネクタを作成し、Application Integration の接続で使用してウェブサービスを検証する必要があります。
始める前に
この仮想マシンに Private Service Connect(PSC)を設定し、エンドポイント アタッチメントを作成します。
カスタム コネクタを作成する
- コンソールで、[Integration Connectors] > [カスタム コネクタ] ページに移動し、 Google Cloud プロジェクトを選択または作成します。
- [新規作成] をクリックして [カスタム コネクタを作成する] ページを開きます。
- [コネクタの詳細] セクションで、[コネクタ名] や [表示名] などの必須フィールドを指定します。また、[説明] フィールドにコネクタのユースケースを入力します。
- バックエンド アクセスのコネクタの宛先を構成する: このオプションを有効にします。これにより、ページに追加の構成セクションが表示されます。
- サービス アカウント: 必要なロールを持つサービス アカウントを選択します。
- ロゴ: 画像を Cloud Storage バケットにアップロードして、コネクタのロゴとして使用します。
- [コネクタ仕様] セクションで、Open API 仕様の公開 URL を入力するか、仕様ファイルを Cloud Storage バケットにアップロードします。
- [Connector Destination] セクションで、エンドポイント アタッチメントの IP アドレスと、サービスが実行されているポートを追加します。
- [コネクタ認証] セクションで、[認証なし] を選択します。認証タイプは、Marketplace コネクタではサポートされていません。
- [Backend Variables] セクションで、接続の作成時に入力として使用する変数を追加します。これらの変数は接続作成ページに表示され、サービスに対して行われた API 呼び出しごとに送信されます。サードパーティのバックエンド認証情報など、API で変更されない値は、このセクションに追加する必要があります。
- カスタム コネクタを作成します。ロゴを指定し、カスタム コネクタのユースケースを説明していることを確認します。
接続を作成する
カスタム コネクタを作成したら、このコネクタの接続を作成します。
- Cloud コンソールで、[Integration Connectors] > [接続] ページに移動し、Google Cloud プロジェクトを選択または作成します。
- [新規作成] をクリックして [接続を作成] ページを開きます。
- 作成したカスタム コネクタを選択します。
- 定義した接続フィールドに値を追加します。
- 接続を作成します。
サービスを検証する
サービスを検証するには、新しい統合を作成します。
- Google Cloudコンソールで、[Application Integration] ページに移動し、統合を作成します。
- API トリガーとコネクタタスクを追加します。
- 前の手順で作成した接続を使用するようにコネクタタスクを構成します。必要に応じてデータ マッパーを追加します。
- スキーマに従って、コネクタの connectorInputPayload を設定します。
- 統合を実行して、接続が機能していることを確認します。
統合が正常に実行され、想定どおりのレスポンスを返す場合、ウェブサービスは検証されます。
次のステップ
- ウェブサービスの起動スクリプトを作成する方法を学習する。