自己管理型サーバーでの API インスタンスの追加
自己管理型サーバーで API を実行している場合、API インスタンスを追加するための 2 つのオプションがあります。
-
Manage API from Exchange (Exchange から API を管理)
-
Create new API (新しい API を作成)
Exchange から API インスタンスを管理する
Exchange から API インスタンスを管理する手順は、次のとおりです。
-
[Anypoint Platform] > [API Manager] に移動します。
-
[API Administration (API 管理)] で、[Add API (API を追加)] をクリックし、[Add new API (新しい API を追加)] をクリックします。
-
ランタイムとして [Mule Gateway (Mule ゲートウェイ)] を選択します。
-
[Proxy type (プロキシ種別)] で [Deploy a proxy application (プロキシアプリケーションをデプロイ)] を選択します。
-
[Target type (対象種別)] で [Hybrid (ハイブリッド)] を選択します。
-
ページの下部にある [self-managed server (自己管理型サーバー)] リンクをクリックします。
-
[Manage API from Exchange (Exchange から API を管理)] をクリックします。 .
-
[API Name (API 参照名)] で、Exchange で使用可能な API のリストから、管理する API を検索します。
[Asset type (アセットタイプ)]、[API version (API バージョン)]、および [Asset version (アセットバージョン)] 項目は自動的に入力されます。
OpenAPI 仕様 (OAS) 3.0 はサポートされていますが、コールバック機能はサポートされていません。この問題を回避するには、Mule Runtime Engine ドメインの外部でコールバックを処理するか、コールバックを使用しない OAS 3.0 仕様を使用します。 -
[Managing Type (管理種別)] で、作成する API エンドポイントの種別を選択します。
-
Basic Endpoint (基本エンドポイント): API Manager 以外で API を作成し、ポリシーを適用する場合はこのオプションを使用します。それ以外の場合は API Manager を使用して API を管理します。たとえば、Mule Runtime を使用して API を作成する場合、プロキシは必要ありません。
以下のオプションからアプリケーション種別を選択します。
-
Mule Application (Mule アプリケーション): Mule アプリケーションを実行している場合、このオプションを使用します。
-
Non-Mule Application managed by Anypoint Service Mesh (Anypoint Service Mesh によって管理される非 Mule アプリケーション): Anypoint Service Mesh を使用して Kubernetes ベースの非 Mule マイクロサービスを管理する場合、このオプションを使用します。
-
-
Endpoint with Proxy (プロキシを使用したエンドポイント): API に追加のセキュリティを提供する場合、このオプションを使用します。
-
-
Mule 4 以降 (推奨) を使用して API を管理する場合は、デフォルトで選択されている Mule バージョンを受け入れます。
指定する必要があるパラメーターは、選択した Mule バージョンによって異なります。項目の詳しい説明については、パラメーターの詳細を参照してください。
-
[Implementation URI (実装 URI)] で、API をホストするサイトの URL を入力して例を置き換えます。
たとえば、Exchange の API アセットの URL を使用できます。この場合、API は JSONPlaceholder API をコンシュームするため、「
http://jsonplaceholder.typicode.com」と入力します。 -
アウトバウンドトラフィックを保護するには、[TLS Context for outbound traffic (アウトバウンドトラフィックの TLS コンテキスト)] で、[Add TLS context (TLS コンテキストを追加)] をクリックし、[Select TLS Context (TLS コンテキストを選択)] ウィンドウに詳細を入力します。
-
プロキシを使用したエンドポイントを作成する場合、[Path (パス)] 項目でプロキシエンドポイントのベースパス
/ を受け入れるか、別のパスを入力します。たとえば、API が定義されていて、[
Implementation URI (実装 URI)] が http://jsonplaceholder.typicode.com に設定されている場合、プロキシは、プロキシパスで設定した値に基づいて次の URI を返します。プロキシパス 要求 プロキシからの応答 //api -
必要に応じて、API の追加設定を微調整するには、[Advanced options (詳細オプション)] を展開し、詳細を指定して [Save (保存)] をクリックします。
Create new API (新しい API を作成)
新しい API インスタンスを作成してエンドポイントを設定する手順は、次のとおりです。
-
[Anypoint Platform] > [API Manager] に移動します。
-
[API Administration (API 管理)] で、[Add API (API を追加)] をクリックし、[Add new API (新しい API を追加)] をクリックします。
-
ランタイムとして [Mule Gateway (Mule ゲートウェイ)] を選択します。
-
[Proxy type (プロキシ種別)] で [Deploy a proxy application (プロキシアプリケーションをデプロイ)] を選択します。
-
[Target type (対象種別)] で [Hybrid (ハイブリッド)] を選択します。
-
ページの下部にある [self-managed server (自己管理型サーバー)] リンクをクリックします。
-
[Create new API (新しい API を作成)] をクリックします。
-
API の名前を入力します。
-
アセットタイプを選択します。
-
必要に応じて、ファイルのアップロードを選択します。
-
[Continue (続行)] をクリックします。
-
[Managing Type (管理種別)] で、作成する API エンドポイントの種別を選択します。
-
Basic Endpoint (基本エンドポイント): API Manager 以外で API を作成し、ポリシーを適用する場合はこのオプションを使用します。それ以外の場合は API Manager を使用して API を管理します。たとえば、Mule Runtime を使用して API を作成する場合、プロキシは必要ありません。
以下のオプションからアプリケーション種別を選択します。
-
Mule Application (Mule アプリケーション): Mule アプリケーションを実行している場合、このオプションを使用します。
-
Non-Mule Application managed by Anypoint Service Mesh (Anypoint Service Mesh によって管理される非 Mule アプリケーション): Anypoint Service Mesh を使用して Kubernetes ベースの非 Mule マイクロサービスを管理する場合、このオプションを使用します。
-
-
Endpoint with Proxy (プロキシを使用したエンドポイント): API に追加のセキュリティを提供する場合、このオプションを使用します。
-
-
Mule 4 以降 (推奨) を使用して API を管理する場合は、デフォルトで選択されている Mule バージョンを受け入れます。
指定する必要があるパラメーターは、選択した Mule バージョンによって異なります。項目の詳しい説明については、パラメーターの詳細を参照してください。
-
[Implementation URI (実装 URI)] で、API をホストするサイトの URL を入力して例を置き換えます。
たとえば、Exchange の API アセットの URL を使用できます。この場合、API は JSONPlaceholder API をコンシュームするため、「
http://jsonplaceholder.typicode.com」と入力します。 -
アウトバウンドトラフィックを保護するには、[TLS Context for outbound traffic (アウトバウンドトラフィックの TLS コンテキスト)] で、[Add TLS context (TLS コンテキストを追加)] をクリックし、[Select TLS Context (TLS コンテキストを選択)] ウィンドウに詳細を入力します。
-
プロキシを使用したエンドポイントを作成する場合、[Path (パス)] 項目でプロキシエンドポイントのベースパス
/ を受け入れるか、別のパスを入力します。たとえば、API が定義されていて、[
Implementation URI (実装 URI)] が http://jsonplaceholder.typicode.com に設定されている場合、プロキシは、プロキシパスで設定した値に基づいて次の URI を返します。プロキシパス 要求 プロキシからの応答 //api -
必要に応じて、API の追加設定を微調整するには、[Advanced options (詳細オプション)] を展開し、詳細を指定して [Save (保存)] をクリックします。
項目の入力参照
Exchange から API を追加するときに指定する必要がある入力は、プロキシを使用したエンドポイントを作成するかどうか、API が Mule3 と Mule4 のどちらを使用して作成されたかなど、特定の状況によって異なります。
| 項目名 | 説明 | 必須 | 注意事項 |
|---|---|---|---|
Implementation URI (実装 URI) |
プロキシまたは API にアクセスするための URL。 |
はい |
たとえば、Exchange の API アセットの URL を使用できます。この場合、API は JSONPlaceholder API をコンシュームするため、「 |
Proxy version (プロキシバージョン) |
エンドポイントに使用するプロキシのバージョンを指定します。 |
いいえ |
|
Enable Console (コンソールを有効化) |
API 仕様を公開およびテストできるかどうかを指定します。 |
いいえ |
[Console Path (コンソールパス)] に別のパス (「/spec/*」など) を指定できます。 |
Validations (検証) |
提供された仕様に対してインバウンド要求を検証するかどうかを指定します。 |
いいえ |
提供された仕様に対して、またはクエリパラメーターを使用して、受信要求を検証するように検証を設定できます。 |
Scheme (スキーム) |
検証に HTTP と HTTPS のどちらを使用するかを指定します。 |
はい |
HTTPS を選択する場合、インバウンドトラフィックの TLS コンテキストを指定します。 |
API Instance label (API インスタンス表示ラベル) |
API の表示ラベルを指定します。 |
いいえ |
同じ API の複数の管理インスタンスがある場合、各インスタンスを他のインスタンスと区別するための表示ラベルを追加します。 |
Port (ポート) |
表示されたポートが正しくない場合に使用する番号を指定します。 |
いいえ |
|
Response Timeout (応答タイムアウト) |
要求がタイムアウトするまでの期間を指定します。 |
いいえ |
|
Reference user domain (ユーザードメインを参照) |
API ゲートウェイドメインを使用するかどうかを指定します。 |
いいえ |
設定で以前にプロキシデプロイメント対象として [Hybrid (ハイブリッド)] を選択した場合は、必ずこのオプションを選択してください。Mule 3.8 以降の API ゲートウェイドメインをインストールする必要があります。 |