API 同期

Anypoint Studio の API 同期機能を使用すると、以下を行うことができます。

  • Studio で RAML、または OAS 2.0 および 3.0 API 仕様の設計を開始して、Design Center と同期できます。

  • パブリッシュされた RAML または OAS 2.0 および 3.0 API 仕様を Exchange または非公開 Maven リポジトリから Studio の Mule アプリケーションプロジェクトに取得して、新しいプロジェクトをスキャフォールディングできます。
    API 同期を使用すると、Exchange からインポートした API 仕様を編集して、変更を Design Center にプッシュすることもできます。

    API 同期を複数の API 仕様で使用し、複数のフローを異なる Mule 設定ファイルでスキャフォールディングすることができます。

  • プロジェクトに実装した API バージョンを監視してパブリッシュされた最新バージョンに基づいてフローを更新することもできます。

  • RAML または OAS 2.0 および 3.0 API 仕様を Design Center から Studio に取得して、仕様をオフラインで編集してから、更新を Design Center に戻すことができます。

API 同期は、RAML、OAS 2.0、OAS 3.0 のすべての仕様のインポートをサポートしています。

API 同期は、デフォルトで Studio にバンドルされていて、Mule 4.1.4 以降が必要です。

RAML ファイルのテキストが 4,000 行を超えると、API 同期は適切に機能しない場合があります。

API 同期を使用すると、API のライフサイクル開発プラクティスに従って Mule アプリケーションを開発できます。

Studio での API 仕様の作成

  1. Studio で新しい API 仕様プロジェクトを開始します。 詳細は、​「Studio での API 仕様プロジェクトの作成」​を参照してください。

  2. Exchange にパブリッシュします。

  3. 同じ API 仕様を Exchange から Studio プロジェクトにインポートします。
    詳細は、​「Exchange からの API 仕様のインポート」​を参照してください。

Exchange から新しい Mule プロジェクトに API 仕様をインポートする

  1. Design Center で API 仕様を作成します。
    Design Center のテキストエディターを使用して API 仕様を作成​するか、または ​Design Center のビジュアル API エディターを使用して API 仕様を作成​することができます。

  2. Exchange にパブリッシュします。
    詳細は、​「API 仕様のパブリッシュ」​を参照してください。

  3. 同じ API 仕様を Exchange から Studio プロジェクトにインポートします。
    詳細は、​「Exchange からの API 仕様のインポート」​を参照してください。

最新バージョンの API 仕様を使用して Studio プロジェクトを最新の状態に保つ手順については、​「プロジェクトの API 仕様の更新」​を参照してください。

インポートした API 仕様を Studio で編集する

インポートした API 仕様を、プロジェクト内で API 仕様プロジェクトとして編集することもできます。

  1. API 仕様を Exchange から Studio プロジェクトにインポートします。

  2. API 仕様を Design Center と同期させます。

  3. Exchange にパブリッシュします。

  4. API の新しいバージョンをインポートします。

Design Center から編集可能なプロジェクトに API 仕様プロジェクトをインポートする

  1. Design Center で API 仕様を作成します。
    Design Center のテキストエディターを使用して API 仕様を作成​するか、または ​Design Center のビジュアル API エディターを使用して API 仕様を作成​することができます。

  2. 同じ API 仕様を Design Center から Studio プロジェクトにインポートします。
    手順は​「Design Center との API 仕様の同期」​を参照してください。