1. Homepage
  2. Studio (7.x)
  3. API 同期

  4. Design Center との API 仕様の同期

Design Center との API 仕様の同期

Anypoint Studio では、Design Center で作成した RAML、OAS 2.0、または OAS 3.0 の API 仕様を Studio の API 仕様プロジェクトにインポートして、オフラインで編集してから、任意のバージョン管理システム (VCS) で行うように変更をステージングしてプッシュできます。

この機能は、下記のプロセスで API を Design Center からインポートする場合にのみ使用できます。
Mule アプリケーション実装を作成するための API 仕様をインポートする方法は、​「Design Center からの API 仕様のインポート」​を参照してください。

API 仕様プロジェクトの名前は、ワークスペース内の他のプロジェクトの名前とは異なる必要があります。

Studio では、API 仕様をオフラインで編集する場合の VCS 機能でのみ EGit プラグインを使用します。Studio は、Mule アプリケーションプロジェクトでは (独自の VCS を使用してバージョンを追跡できるため) EGit プラグインをサポートしません。

ローカル編集するために Design Center から API 仕様をインポートする

  1. ワークスペースに、インポートする API プロジェクトと同じ名前の他のプロジェクトがないことを確認します。

  2. Anypoint Studio 画面の上部にあるタスクバーで、​[File (ファイル)]​ > ​[Import (インポート)]​ を選択します。

  3. [Anypoint Studio]​ > ​[API Specification from Design Center (Design Center からの API 仕様)]​ を選択します。

  4. [Import From Design Center (Design Center からのインポート)]​ ウィンドウで、API 仕様が配置されている Anypoint Platform ユーザー名と Anypoint Platform ビジネスグループを選択します。

    username and bg studio

    ログインしていない場合、​[Add Account (アカウントを追加)]​ ボタンをクリックして、Anypoint Platform アカウントを追加します。Anypoint Platform ログイン情報を設定していない場合は、ユーザー名とビジネスグループのオプションは選択できません。
    別のアカウントを使用する場合は、​[Add Account (アカウントを追加)]​ ボタンをクリックして再びログインします。

  5. 使用可能な API のリストから、必要な API を選択します。

    list of apis studio

  6. [Finish (完了)]​ をクリックします。

Studio は、API 仕様を API 仕様プロジェクトとしてインポートして、API 仕様プロジェクトをオフラインで編集できるようにします。

分岐を作成する

Design Center から取得した分岐に基づいて独自の分岐を作成できます。
異なる分岐を使用することで、Design Center のメイン分岐に変更をプッシュしてしまうリスクを避けて API 仕様を変更できます。

Studio で異なる分岐を作成するには、次の手順を実行します。

  1. [Package Explorer] ビューで API 仕様プロジェクトを右クリックして、​[Team (チーム)]​ > ​[Switch To (切り替え先)]​ > ​[New Branch…​ (新規分岐…​)]​ を選択します。

    switch to new branch

  2. [Create Branch (分岐の作成)]​ ウィンドウで、新しい分岐を設定します。

    create new branch
1 [branch name (分岐名)]​ 項目で、新しいポリシーバージョンの名前を入力します。
2 [Configure upstream for push and pull (プッシュとプルのアップストリームを設定)]​ オプションを選択して、Design Center から変更を取得することもできます。
このオプションを設定する場合は、Git が Design Center から変更を取得するときの動作を選択する必要があります。
3 [Check out new branch (新しい分岐のチェックアウト)]​ を選択すると、分岐を作成した時点ですぐに新しい分岐に切り替えることができます。

  1. [Finish (完了)]​ をクリックします。

新しい分岐を作成したら、変更のコミットを開始します。

API 仕様プロジェクトに変更をコミットする

Studio の VCS はプロジェクトに対するすべての変更を追跡し、​Git ステージング​ビューの ​[Unstaged Changes (ステージングされていない変更)]​ セクションに表示します。

[Unstaged Changes (ステージングされていない変更)]​ セクションでファイルを右クリックして ​[Compare with Index (インデックスと比較する)]​ を選択して、ファイルへの変更を追跡できます。

compare with index

変更を適用したら、インデックスに追加します。

compare to index view
1 選択したファイルのコミットをステージングするには、​[Add selected files to the index (選択したファイルをインデックスに追加する)]​ アイコンを選択します。
2 ステージングされていないすべての変更のコミットをステージングするには、​[Add all files including not selected ones to the index (未選択ファイルを含めたすべてのファイルをインデックスに追加する)]​ アイコンを選択します。

コミットする変更をステージングしたら、​[Commit Message (コミットメッセージ)]​ セクションでコミットメッセージを作成します。

add commit message
1 [Commit and Push (コミットしてプッシュ)]​ を選択すると、Design Center への変更のプッシュも行われます。
詳細は、下記の​「Design Center への分岐のプッシュ」​を参照してください。
2 [Commit (コミット)]​ を選択して、ローカルコピーにコミットを追加します。

このビューの詳細は、​「Git ステージングビューリファレンス」​を参照してください。

メイン分岐に変更をマージする

ローカル分岐で行った変更をメイン分岐にマージして Design Center にプッシュできます。

  1. [Package Explorer] ビューで API 仕様プロジェクトを右クリックして、​[Team (チーム)]​ > ​[Merge (マージ)]​ > ​[Push Branch…​ (分岐のプッシュ…​)]​ を選択します。

    merge menu

  2. 変更をマージするローカル分岐を選択します。

    merge view

  3. [Merge (マージ)]​ を選択します。

Design Center に分岐をプッシュする

すべての変更をローカル分岐にコミットしたら、ローカル分岐をローカル分岐を Design Center にプッシュするように選択できます。

  1. [Package Explorer] ビューで API 仕様プロジェクトを右クリックして、​[Team (チーム)]​ > ​[Switch To (切り替え先)]​ > ​[Push Branch…​ (分岐のプッシュ…​)]​ を選択します。

    push branch

  2. Design Center にプッシュする変更を確認します。

    push branch view
1 [Source (ソース)]​ セクションには、Design Center にプッシュする変更が表示されています。
2 [Remote (リモート)]​ セクションには、プッシュ先の座標が表示されています。
3 [Branch (分岐)]​ セクションには、プッシュするローカル分岐が表示されています。
4 [Configure upstream for push and pull (プッシュとプルのアップストリームを設定)]​ オプションを選択して、Design Center から変更を取得することもできます。
このオプションを設定する場合は、Git が Design Center から変更を取得するときの動作を選択する必要があります。
5 [Force overwrite branch in remote if it exists and has diverged (リモートに分岐が存在して仕様から外れている場合には分岐の上書きを適用)]​ は、ローカルの変更で Design Center の変更を上書きする必要があることがわかっている場合にのみ選択してください。
このオプションは、Design Center の分岐に対してローカルな変更を強制的にプッシュします。

  1. [Preview (プレビュー)]​ を選択して、プッシュしようとしている変更のサマリーを表示します。

  2. [プッシュ]​ を選択します。

バージョンをダウンロードしてローカルで編集している間に、他のユーザーが Design Center で同じバージョンを編集してしまうケースがあります。この場合は、Git で競合が発生します。
詳細は​「競合の解決」​を参照してください。

関連情報