1. Homepage
  2. Studio (7.x)

  3. Studio での API 仕様プロジェクトの作成

Studio での API 仕様プロジェクトの作成

Anypoint Studio では、Studio で RAML API 仕様、OAS 2.0 または 3.0 API 仕様、API フラグメントを作成し、自動的に Design Center と同期できます。

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

Studio での API 仕様プロジェクトの作成を開始するには、Anypoint Platform にログインする必要があります。​「Platform ログイン情報の設定」​を参照してください。

  1. Anypoint Studio 画面の上部にあるタスクバーで、​[File (ファイル)]​ > ​[New (新規)]​ > ​[API Specification Project (API 仕様プロジェクト)]​ を選択します。

  2. 作成する API 仕様プロジェクトの種別のタブを選択します。

    • API 仕様を新規作成するには、​[New API Specification (新規 API 仕様)]​ タブを選択し、API の種別を選択します。

      create api specification

    • API フラグメントを新規作成するには、​[New API Fragment (新規 API フラグメント)]​ タブを選択し、API フラグメントの種別を選択します。

      create api fragment

  3. プロジェクトの名前を入力します。

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

Studio で、API デザインパースペクティブに切り替えるよう要求されます。

API デザインパースペクティブで、API エディターを使用して API 仕様または API フラグメントを記述します。さらに、[API Console] ビューを使用して API 仕様をテストできるようにライブサービスをモックできます。

Studio では VCS を使用して 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 ステージングビューリファレンス」​を参照してください。

API 仕様プロジェクトのマージとプッシュ

API 仕様に対して行った変更をメイン分岐にマージして、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 で競合が発生します。
詳細は​「競合の解決」​を参照してください。

関連情報