API 仕様プロジェクトへの連動関係としての RAML API フラグメントの追加

API 仕様または API フラグメントのプロジェクトでは、RAML API フラグメントを依存関係として Anypoint Exchange から直接追加できます。

このタスクについて

フラグメントはプロジェクト内にリストされますが、プロジェクト内に存在するわけではありません。コードエディタは、Anypoint Exchange 内のオンラインの場所からフラグメントを参照します。そのため、作成した仕様やフラグメントにフラグメントを含めることはできますが、編集することはできません。

プロジェクトをエクスポートすると、生成される .zip ファイルには参照された API フラグメントが含まれます。Anypoint Exchange にパブリッシュしたプロジェクトを他のユーザが RAML としてダウンロードすると、その .zip ファイルにも参照された API フラグメントが含まれます。

プロジェクトをエクスポートして別のエディタで開き、参照された API フラグメントを編集してからプロジェクトをコードエディタにインポートしようとすると、インポートは失敗します。

手順

  1. エディタの左側で、[Exchange dependencies (Exchange 連動関係)] アイコンをクリックします。

  2. 左側のペインの一番上にあるプラス記号をクリックします。

  3. インポートする API フラグメントを選択します。自分が属する組織で表示可能な API フラグメントを選択できます。

結果

左側のペインに選択した API フラグメントが表示されます。フラグメントを選択すると、その内容が表示されます。プロジェクトの作業を続行するには、[Files (ファイル)]​アイコンをクリックします。

exchange-modules フォルダにファイルが表示されます。このフォルダには、参照された API フラグメントの URI の各部に対応するサブフォルダがあります。

API フラグメントとの連動関係を追加した後で、フラグメントの更新バージョンがパブリッシュされ、プロジェクトで新バージョンを参照したい場合は、連動関係を更新する必要があります。この場合は、[Exchange dependencies (Exchange 連動関係)]​アイコンをクリックし、連動関係をクリックしてから [Change version (バージョンを変更)] を選択します。[Change version (バージョンを変更)] ダイアログで、最新バージョンを選択します。

Was this article helpful?

💙 Thanks for your feedback!

Edit on GitHub