1. Homepage
  2. API Manager (2.x)
  3. API インスタンスの管理
  4. API インスタンスの追加

  5. Service Mesh API インスタンスの追加

Service Mesh API インスタンスの追加

Design Center またはその他のアプリケーションを使用して API を作成したら、API インスタンスを追加して、API Manager でその API を管理できます。API は、削除するまで API Manager の管理下に置かれます。

Mule アダプターのデプロイメントを通して Anypoint Platform の API 管理機能を Istio サービスメッシュに拡張するには、Service Mesh を選択します。

API インスタンスを追加するには、次の 3 つのオプションがあります。

API インスタンスを昇格またはインポートするときに、設定を変更するオプションはありません。ただし、新しい API インスタンスを追加する場合、ダウンストリームとアップストリームの設定を定義する必要があります。

次の図は、アップストリームおよびダウンストリームの設定と、アップストリームサービスおよびダウンストリームコンシューマーアプリケーションとの関係を示しています。この設定では、ダウンストリームサービスは、アップストリームサービスによって完了される API 要求を行うサービスです。これらの用語は、情報の方向ではなく、連動関係の方向を表します。ダウンストリームサービスは、アップストリームサービスに情報を提供する ​POST​ 要求を行うことができます。ただし、ダウンストリームサービスは、要求の完了には引き続きアップストリームサービスに連動します。

API インスタンスは、アップストリーム設定とダウンストリーム設定の間のゲートウェイにデプロイされます。

新しい API を追加する

  1. [Anypoint Platform]​ > ​[API Manager]​ に移動します。

  2. [API Administration (API 管理)]​ で、​[Add API (API を追加)]​ をクリックし、​[Add new API (新しい API を追加)]​ をクリックします。

  3. [Service Mesh]​ を選択します。

    Anypoint Platform に API を追加したら、Anypoint Service Mesh クライアントを使用して API をサービスにバインドする必要があります。詳細は、​「Anypoint Service Mesh の設定方法」​を参照してください。

  4. [Next (次へ)]​ をクリックします。

  5. 以下のオプションから API を選択します。

    • 管理する API を Exchange を介して共有している場合、​[Select API from Exchange (Exchange から API を選択)]​ をクリックします。

      1. [Select API (API を選択)]​ の下のリストから API をクリックします。必要に応じて、特定の API を検索できます。

      2. 最新バージョンを使用していない場合は、​[Asset type (アセットタイプ)]​、​[API version (API バージョン)]​、および ​[Asset version (アセットバージョン)]​ を更新します。

        Exchange でのバージョンについての詳細は、アセットバージョンを参照してください。

      3. [RAML/OAS]​ アセットタイプを選択した場合は、API の ​[Conformance Status (準拠状況)]​ を表示して、API が準拠していることを確認します。​[Conformance Status (準拠状況)]​ が非準拠の場合、デプロイ後に​ガバナンスレポート​を表示して、準拠の問題を見つけて修正します。​ガバナンスレポート​についての詳細は、API インスタンスの管理を参照してください。

    • [Create new API (新しい API を作成)]​ をクリックします。

      1. 新しい API アセットの​名前​を入力します。

      2. 以下のオプションから​アセットタイプ​を選択します。

        • REST API:​ アセットに含める RAML または OAS API 定義ファイルがある場合は、このオプションを選択します。

          REST API の RAML または OAS ファイルをアップロードします。バージョン 2.0.0 以降ではネイティブ OAS サポートが追加されるので、OAS または RAML 仕様に推奨されるバージョンです。OAS API 仕様を API プロキシバージョン 1.0 以前にアップロードすると、API 仕様は RAML に変換されます。

        • HTTP API:​ アセットに含める API 定義ファイルがない場合は、このオプションを選択します。

        • SOAP API:​ WSDL API 定義ファイルまたはファイルへの外部リンクがある場合は、このオプションを選択します。

          SOAP API の WSDL ファイルをアップロードするか、ファイルへのリンクを追加します。
          このオプションは、現時点では Flex Gateway ランタイムでは使用できません。

      3. 最新バージョンを使用していない場合は、​[Asset type (アセットタイプ)]​、​[API version (API バージョン)]​、および ​[Asset version (アセットバージョン)]​ を更新します。

        Exchange でのバージョンについての詳細は、アセットバージョンを参照してください。

      4. [RAML/OAS]​ アセットタイプを選択した場合は、API の ​[Conformance Status (準拠状況)]​ を表示して、API が準拠していることを確認します。[Conformance Status (準拠状況)] が非準拠の場合、デプロイ後に​ガバナンスレポート​を表示して、準拠の問題を見つけて修正します。​ガバナンスレポート​についての詳細は、API インスタンスの管理を参照してください。

  6. [Next (次へ)]​ をクリックします。

  7. ダウンストリーム設定を定義します。

    項目名 説明 必須 注意事項

    Instance label (インスタンス表示ラベル)

    API の表示ラベルを指定します。

    いいえ

    同じ API の複数の管理インスタンスがある場合、各インスタンスを他のインスタンスと区別するための表示ラベルを追加します。

    Advanced Options (詳細オプション)

    Consumer endpoint (コンシューマーエンドポイント)

    コンシューマーが要求の送信に使用するプロキシアプリケーションのアドレスを指定します。

    いいえ

    Client provider (クライアントプロバイダー)

    API のクライアントプロバイダーを指定します。

    はい

    Anypoint Platform はデフォルトではクライアントプロバイダーとして機能します。外部クライアントプロバイダーを設定するには、​「クライアントプロバイダー」​を参照してください。

  8. [Next (次へ)]​ をクリックします。

  9. アップストリーム設定を定義します。

    項目名 説明 必須 注意事項

    Upstream URL (アップストリーム URL)

    プロキシまたは API にアクセスするための URL。

    いいえ

    たとえば、Exchange の API アセットの URL を使用できます。

  10. [Next (次へ)]​ をクリックします。

  11. 選択内容を確認し、必要に応じて編集します。

  12. デプロイする準備ができたら、​[Save & Deploy (保存してデプロイ)]​ をクリックします。または、​[Save (保存)]​ を選択して API インスタンスを保存し、後でデプロイします。

別の環境への API インスタンスの昇格

  1. [Anypoint Platform]​ > ​[API Manager]​ に移動します。

  2. [API Administration (API 管理)]​ で、​[Add API (API を追加)]​ をクリックし、​[Promote API from environment (環境から API を昇格)]​ を選択します。

  3. [Source Environment (ソース環境)]​ を選択します。

  4. 検索項目に API の名前を入力して、​[API]​ を選択します。

  5. [API Version (API バージョン)]​ を選択します。

  6. [API instance label (API インスタンスの表示ラベル)]​ を選択します。

  7. 必要に応じて、除外する ​[Include in Promotion (昇格に含める)]​ オプションをオフにます。

  8. [Promote (昇格)]​ をクリックします。

  9. 必要に応じて、[Runtime & Endpoint Configuration (ランタイムとエンドポイント設定)] の詳細を確認して更新し、​[Save (保存)]​ をクリックします。

Zip ファイルから API をインポートする

  1. [Anypoint Platform]​ > ​[API Manager]​ に移動します。

  2. [API Administration (API 管理)]​ で、​[Add API (API を追加)]​ をクリックし、​[Import API from zip file (zip ファイルから API をインポート)]​ を選択します。

  3. [Choose file (ファイルを選択)]​ をクリックし、API インスタンス設定 zip ファイルを選択します。

  4. [Next (次へ)]​ をクリックします。

  5. 必要に応じて API 設定の詳細を確認して更新し、​[Save (保存)]​ をクリックします。

注意事項

  • OpenAPI 仕様 (OAS) 3.0 はサポートされていますが、コールバック機能はサポートされていません。この問題を回避するには、Mule Runtime Engine ドメインの外部でコールバックを処理するか、コールバックを使用しない OAS 3.0 仕様を使用します。