Anypoint Platform DataGraph CLI および API 拡張機能の使用

Anypoint CLI DataGraph コマンドを使用して、DataGraph で API ソースを追加および編集できます。そのためには、最初の適切な DataGraph API 拡張機能を API ソースに追加する必要があります。

プロジェクトへの拡張機能の追加

拡張機能を連動関係として API 仕様プロジェクトに追加し、続いてプロジェクトを Exchange にパブリッシュする必要があります。API 仕様プロジェクトをパブリッシュした後で、CLI を使用して API を DataGraph に追加できます。

API Designer を使用して拡張機能をプロジェクトに追加します。​「API 仕様プロジェクトに連動関係を追加する」​の手順に従い、連動関係種別として ​[Fragments (フラグメント)]​ を選択します。

API Designer により、必須の連動関係が ​exchange.json​ に追加され、プロジェクトを Exchange にパブリッシュする前に追加したアノテーションの構文が検証されます。

RAML の互換性の維持

RAML 仕様で API 拡張機能がサポートされないツールとの互換性を維持するために、これらの拡張機能には RAML アノテーション定義のシンプルなバージョンが提供される「RAML companion」が含まれています。RAML で DataGraph API 拡張機能を使用するには、次のコードを API プロジェクト仕様のメインファイルに追加します。

uses:
  dg: exchange_modules/<group>/<asset>/<version>/datagraph-api-extensions.raml

プレフィックス ​dg​ は必要に応じて変更できますが、拡張機能で使用されているプレフィックスに一致している必要があります。

<group>​、​<asset>​、​<version>​ は Exchange でパブリッシュされている API 拡張機能を参照します。

DataGraph CLI と DataGraph UI の使用の比較

CLI を使用して API ソースを追加する場合は、UI で直接編集したりそのバージョンを更新したりすることはできません。これらの変更は CLI を使用して行う必要があります。