API 仕様のパブリッシュ
API 仕様を他の開発者と共有する場合、Anypoint Exchange にパブリッシュできます。
始める前に
プロジェクトを Anypoint Exchenge にパブリッシュする前に、参照されていないファイルを削除することをお勧めします。参照されていないファイルは、プロジェクトのルートファイルから直接または間接的に参照されていません。
たとえば、ファイル example.raml がプロジェクト内のファイルの 1 つであり、プロジェクトのルートファイルが !include タグを使用して example.raml を参照していない場合、ルートファイルは example.raml を直接参照しません。ルートファイルからの参照のチェーン内にあるどのファイルも example.raml を直接参照していない場合、そのファイルはルートファイルから間接的に参照されません。そのため、example.raml は参照されていないファイルとなり、おそらくプロジェクト内に含まれるべきではありません。
開始する前にそれらを削除しないと、Exchange にパブリッシュするオプションを選択したときに参照されていないファイルが検出され、それらをパブリッシュするかどうかのオプションが表示されます。
API 仕様のパブリッシュ
-
API Designer で、パブリッシュする API 仕様プロジェクトを開きます。
-
仕様に連動関係がある場合は、
Exchange Dependencies の横にある更新ボタンをクリックして、Design Center にすべての連動関係の最新の状況とコンテンツが適用されるようにします。 -
[Publish (パブリッシュ)] をクリックし、[Publish to Exchange (Exchange へのパブリッシュ)] をクリックします。
| 1 | Asset version (アセットバージョン): Anypoint Exchange によって作成される、プロジェクト用のページの [Version (バージョン)] セクションに表示されるバージョン番号。この項目についての詳細は、「アセットバージョン」を参照してください。 |
| 2 | API version (API バージョン): API 仕様のバージョン番号。この項目についての詳細は、「API バージョン」を参照してください。
|
| 3 | LifeCycle State (ライフサイクル状態): アセットのライフサイクル状態。アセットは API Designer から [Development (デプロイメント)] または [Stable (安定)] としてパブリッシュできます。API Designer からアセットを非推奨にすることはできません。 |
| 4 | Business group ID (ビジネスグループ ID): プロジェクトが属する Anypoint Platform のビジネスユニットの ID。 |
| 5 | [Asset name (アセット名)]: Anypoint Exchange がパブリッシュされたプロジェクトを識別するために使用する名前。 |
| 6 | Asset ID (アセット ID): Anypoint Exchange がパブリッシュされたプロジェクトを識別するために使用する一意の ID。同じ ID のパブリッシュ済みアセットがない場合、デフォルトを使用する必要があります。 |
-
必須項目の入力が完了したら、[Publish to Exchange (Exchange にパブリッシュ)] をクリックします。
プロジェクトにルートファイルから直接的または間接的に参照されていないファイルが残っている場合は、ダイアログが開き、参照されていないファイルを含むプロジェクトをパブリッシュするかどうかが尋ねられます。デフォルトでは、API Designer は Anypoint Exchenge にパブリッシュされたプロジェクトからこれらのファイルを削除します。
| 2017 年 4 月より前にリリースされたバージョンの Anypoint Platform を使用しており、Exchange へのパブリッシュ中にアセットを API Manager に追加する場合は、[Add to API Manager (API Manager に追加)] を選択します。この機能は、それ以降のバージョンでは使用できません。代わりに、API Manager の API インスタンスを Exchange のアセットにリンクできます。 |
アセットバージョン
Anypoint Exchange では、パブリッシュされた API 仕様ごとにアセットバージョン番号が必要です。セマンティックバージョン管理ルールを使用して、アセットバージョンを指定する必要があります。詳細は、「アセットのバージョンを変更する」を参照してください。
パブリッシュダイアログの [Asset version (アセットバージョン)] 項目のコンテンツは、次のように条件によって異なります。
-
仕様を初めてパブリッシュする場合、セマンティックバージョン管理スキームに基づいて任意の有効な番号を使用できます。一般的な開始バージョンは
1.0.0 です。 -
仕様を再パブリッシュする場合、[Asset version (アセットバージョン)] 項目には、API Designer によって既存のパッチレベル番号を 1 ずつ増分した値が自動的に入力されます。この番号を変更できますが、すでに使用されているバージョン番号を使用してこの API の安定バージョンをパブリッシュすると、再パブリッシュは失敗します。
-
仕様を再パブリッシュして
Development を選択する場合、以前にパブリッシュされた API の開発バージョンと同じ番号を使用できますが、以前にパブリッシュされた安定バージョンと同じ番号は使用できません。