1. Homepage
  2. Anypoint Code Builder

  3. API の反復的な設計と実装

API の反復的な設計と実装

logo cloud IDE Cloud IDE

logo desktop IDE Desktop IDE

これは進行中のベータリリースです。ベータ状態での Anypoint Code Builder の使用には、該当するベータサービス契約条件が適用されます。

Anypoint Code Builder を使用すると、最初に API を Anypoint Exchange にパブリッシュすることなく、新しいインテグレーションプロジェクトに API 仕様をスキャフォールディングできます。 変更を行ったら、仕様を再スキャフォールディングすることでプロジェクトの変更を同期します。 たとえば、新しいエンドポイントを API 仕様に追加したら、再スキャフォールディングして、そのエンドポイントの新しいフローを設定 XML ファイルに追加します。

Anypoint Code Builder は、Exchange からプロジェクトの連動関係としてインポートする OAS または JSON スキーマフラグメントを参照するスキャフォールディング API 仕様をサポートしていません。 代わりに、仕様内でインラインでフラグメントを指定するか、プロジェクトディレクトリ内で手動で作成したフラグメントファイルを通じて、そのようなフラグメントを含む仕様をスキャフォールディングできます。Exchange の RAML フラグメントは、この制限の影響を受けません。

API 仕様および関連する Mule プロジェクトを同期したら、API 仕様の変更と変更の実装を同時に行うことができます。

この方法を使用して API を実装すると、API 設計の変更が Mule プロジェクトのインターフェースに直接反映されます。 API の設計タスクと実装タスク間を反復することで、開発プロセスの時間を短縮します。

準備が整ったら、API 仕様を Exchange にパブリッシュして Mule プロジェクトをデプロイします。

API 仕様を新しいインテグレーションプロジェクトにスキャフォールディングしたら、Anypoint Code Builder により実装の設定 XML が作成されます。

マルチルートワークスペースに関する考慮事項

API をスキャフォールディングすると、Anypoint Code Builder により、API 仕様とインテグレーションプロジェクトの両方を含む​マルチルートワークスペース​が VS Code に作成され、それらの同期が維持されます。

VS Code では、拡張子 ​.code-workspace​ を含むファイルを使用してマルチルートワークスペースを保存します。 このファイルは、API 仕様と実装プロジェクトのフォルダーをマップします。

プロジェクトを適切に動作させるには、​.code-workspace​ ファイルがどちらのプロジェクトフォルダーにも​存在してはなりません​。

また、Anypoint Code Builder では、反復的な設計フォルダーと実装プロジェクトフォルダーのペアがマルチルートワークスペースごとに 1 つのみ許可されます。

詳細は、VS Code ドキュメントの 「Multi-root Workspaces (マルチルートワークスペース)^」​を参照してください。

始める前に

API 仕様を新しい実装プロジェクトにスキャフォールディングする

現在の API 仕様を新しい実装プロジェクトにスキャフォールディングする方法は、次のとおりです。

  1. アクティビティバーで ​​ (​[Implement this local API (このローカル API を実装)]​) アイコンをクリックします。

    アクティビティバーの [Implement this local API (このローカル API を実装)] アイコン

    または、コマンドパレットを使用します。

    手順を表示

    1. コマンドパレットを開きます

      • キーボードショートカットを使用する。

        • Mac: Cmd+Shift+p

        • Windows: Ctrl+Shift+p

      • デスクトップ IDE で、​[View (表示)]​ > ​[Command Palette (コマンドパレット)]​ を選択する。

      • クラウド IDE で、​​ (メニュー) アイコンをクリックし、​[View (表示)]​ > ​[Command Palette (コマンドパレット)]​ を選択する。

    2. 次のコマンドを選択します。

      MuleSoft: Implement this Local API

  2. プロンプトで ​[OK]​ をクリックします。

    ワークスペースの作成プロンプト

    Anypoint Code Builder により、API 仕様と Mule プロジェクトを含むマルチルートワークスペースが作成されます。 マルチルートワークスペースでは、API 仕様フォルダーと Mule プロジェクトフォルダーの両方を同時に操作できます。

    ワークスペースが作成されたら、Anypoint Code Builder で API 仕様が作成およびパッケージ化されてスナップショットとしてローカル Maven リポジトリにパブリッシュされます。

  3. ワークスペースの保存場所としてホームディレクトリを選択します。

    デフォルトの場所を受け入れないでください。

    ホームディレクトリに ​.code-workspace​ ファイルを保存します。これを API 仕様フォルダーに保存しないでください。

  4. Mule プロジェクトのプロジェクト名を選択します。

  5. Mule プロジェクトの場所を選択します。

    Anypoint Code Builder では、現在のローカル API 仕様を新しい Mule プロジェクトにスキャフォールディングし、完了したらメッセージを表示します。

    スキャフォールディングプロセスの終了メッセージ

    API 仕様と Mule プロジェクトの両方が IDE で開きます。次に例を示します。

    [Explorer] ビューでの API 仕様と実装プロジェクト
    1 API 仕様
    2 実装プロジェクト

  6. [Explorer] ビューで、目的のインターフェースの設定 XML ファイルを開きます。

  7. キャンバス UI が自動的に開かない場合は、アクティビティバーの​​ (​Show Mule graphical mode (Mule グラフィカルモードを表示)​) アイコンをクリックしてキャンバス UI を開きます。

    新しい Mule プロジェクトには、各エンドポイントのフロー、XML ベースの組み込みルーター、エラーハンドラーが含まれており、それらをその後 Mule アプリケーション内に実装します。

    [Explorer] ビューで仕様と実装プロジェクトを切り替えることができます。

マルチルートワークスペースを閉じるには、「​マルチルートワークスペースを閉じる​」を参照してください。

API を再スキャフォールディングする

新しいエンドポイントを追加するなど、API 仕様を変更したら、仕様を再スキャフォールディングして Mule プロジェクトを更新します。

  1. [Explorer] ビューで、API 仕様ファイルに移動します。

  2. コマンドパレットを開きます。

    手順を表示

    • キーボードショートカットを使用する。

      • Mac: Cmd+Shift+p

      • Windows: Ctrl+Shift+p

    • デスクトップ IDE で、​[View (表示)]​ > ​[Command Palette (コマンドパレット)]​ を選択する。

    • クラウド IDE で、​​ (メニュー) アイコンをクリックし、​[View (表示)]​ > ​[Command Palette (コマンドパレット)]​ を選択する。

  3. 次のコマンドを選択します。

    MuleSoft: Re-scaffold this local API

    プロジェクトが正常に再スキャフォールディングされたことを示すメッセージが表示されたら、実装 XML ファイルに移動して、新しいフローが追加されたことを確認します。

マルチルートワークスペースを閉じる

ワークスペースを閉じる手順は、次のとおりです。

  1. コマンドパレットを開きます。

    手順を表示

    • キーボードショートカットを使用する。

      • Mac: Cmd+Shift+p

      • Windows: Ctrl+Shift+p

    • デスクトップ IDE で、​[View (表示)]​ > ​[Command Palette (コマンドパレット)]​ を選択する。

    • クラウド IDE で、​​ (メニュー) アイコンをクリックし、​[View (表示)]​ > ​[Command Palette (コマンドパレット)]​ を選択する。

  2. 次のコマンドを選択します。

    Workspaces: Close Workspace

閉じた後、同期されたプロジェクトを、API の実装時に作成したワークスペースから再度開くことができます。 「​マルチルートワークスペースを開く​」を参照してください。

マルチルートワークスペースを開く

.code-workspace​ ファイルからマルチルートワークスペースを開く手順は、次のとおりです。

  1. コマンドパレットを開きます。

    手順を表示

    • キーボードショートカットを使用する。

      • Mac: Cmd+Shift+p

      • Windows: Ctrl+Shift+p

    • デスクトップ IDE で、​[View (表示)]​ > ​[Command Palette (コマンドパレット)]​ を選択する。

    • クラウド IDE で、​​ (メニュー) アイコンをクリックし、​[View (表示)]​ > ​[Command Palette (コマンドパレット)]​ を選択する。

  2. 次のコマンドを選択します。

    File: Open Workspace from File...

  3. ホームディレクトリに移動して、ワークスペースの ​.code-workspace​ ファイルをダブルクリックします。

    [Explorer] ビューでプロジェクトが開きます。マルチルートワークスペースのフォルダー名には ​(WORKSPACE)​ が含まれています。次に例を示します。

    [Explorer] ビューでのマルチルートワークスペース

関連情報