API 仕様のパブリッシュ

API 仕様を他の開発者と共有する場合、Anypoint Exchange にパブリッシュできます。Exchange により、プロジェクトを表示するページが作成されます。ビジネスグループのすべてのユーザは、このページからプロジェクトを表示およびダウンロードできます。

Exchange によって作成される、パブリッシュされたプロジェクト用のページには、仕様のドキュメントを表示するための左側のペイン、仕様の説明を表示するための中央のペイン、仕様に関するメタデータを表示するための右側のペインがあります。

Exchange にパブリッシュされた仕様のページの例

1 移動してドキュメントを表示できる左側のペイン。このナビゲーションは、仕様のドキュメントから生成されます。
2 仕様の説明が表示される中央のペイン。説明は、仕様をパブリッシュした後に Exchange で作成します。
3 仕様に関するメタデータが表示される右側のペイン。

開始する前に

プロジェクトを Anypoint Exchenge にパブリッシュする前に、参照されていないファイルを削除することをお勧めします。参照されていないファイルとは、プロジェクトのルートファイルから直接的にも間接的にも参照されていないファイルです。

たとえば、プロジェクトに example.raml というファイルがあるとします。このプロジェクトのルートファイルが !include​ タグを使用してこのファイルを参照していない場合、ルートファイルはファイルを直接参照していないことになります。また、ルートファイルからの参照チェーンにおいてどのファイルも example.raml を参照していない場合、example.raml はルートファイルから間接的にも参照されていないことになります。そのため、example.raml は参照されていないファイルとなり、プロジェクトのファイルではない可能性が高いと言えます。

手順

  1. パブリッシュする API 仕様プロジェクトを開きます (まだ開いていない場合)。

  2. API Designer の右上隅で、[Publish (パブリッシュ)]​ をクリックして [Publish to Exchange (Exchange にパブリッシュ)]​ をクリックします。

    結果:​ ダイアログが開きます。

    apid publish dialog api specs

    1 Asset version (アセットバージョン)​: Anypoint Exchange によって作成される、プロジェクト用のページの [Version (バージョン)]​ セクションに表示されるバージョン番号。
    2 API version (API バージョン)​: API 仕様のバージョン番号。この項目についての詳細は、「[API version (API バージョン)]​ 項目の入力」セクションを参照してください。
    3 Business group ID (ビジネスグループ ID)​: プロジェクトが属する Anypoint Platform のビジネスユニットの ID。一部の特殊なケースを除いて、この値は変更しないでください。
    4 [Asset name (アセット名)]​: Anypoint Exchange がパブリッシュされたプロジェクトを識別するために使用する名前。一部の特殊なケースを除いて、この値は変更しないでください。
    5 Asset ID (アセット ID)​: Anypoint Exchange がパブリッシュされたプロジェクトを識別するために使用する ID。一部の特殊なケースを除いて、この値は変更しないでください。
    6 Add to API Manager (API Manager に追加)​: API 仕様を API Portal にパブリッシュすることを指定します。[Publish to Exchange (Exchange にパブリッシュ)]​ をクリックすると、API Designer は仕様を API Manager にもパブリッシュします。仕様は API Manager の [API Administration (API 管理)]​ セクションにリストされます。
  3. 必須項目の入力が完了したら、[Publish to Exchange (Exchange にパブリッシュ)]​ をクリックします。

    プロジェクトにルートファイルから直接的または間接的に参照されていないファイルが残っている場合は、ダイアログが開き、これらの参照されていないファイルと一緒にプロジェクトをパブリッシュするかどうかが尋ねられます。デフォルトでは、API Designer は Anypoint Exchenge にパブリッシュされたプロジェクトからこれらのファイルを削除します。

[API version (API バージョン)]​ 項目の入力

[API version (API バージョン)]​ 項目の外観は、いくつかの要素によって決まります。

  • Anypoint Exchange では、Anypoint Exchange にパブリッシュされた各 API 仕様にバージョン番号が設定されていることが求められます。

  • API Manager では、API 仕様でバージョン番号が指定されていることが求められます。

  • OAS で作成された仕様では、version​ 項目は必須です。

  • RAML で作成された仕様では、version​ ノードは省略可能です。

次のフローチャートは、[API version (API バージョン)]​ 項目の有効/無効と項目への番号の入力の有無を API Designer がどのように決定するのかを示しています。

[API version (API バージョン)]​ 項目の外観は、API 仕様をパブリッシュするときに API Designer が行うチェックの結果によって決まります。

API Designer が行うチェックのフローチャート

1 API Designer は、API 仕様のバージョン番号が仕様内で指定されているかどうかをチェックします。バージョン番号が指定されている場合、[API version (API バージョン)]​ 項目にその番号が入力され、番号を変更できないように項目が無効になります。仕様でバージョン番号が指定されていない場合、API Designer は次のチェックに進みます。
2 API Designer は、[Add to API Manager (API Manager に追加)]​ チェックボックスがオンになっているかどうかをチェックします。API Manager では仕様でバージョン番号が指定されていることが求められるため、チェックボックスがオンになっている場合、API Designer によって続行することができなくなります。チェックボックスがオフになっている場合、API Designer は最後のチェックに進みます。
3 API Designer は、仕様が初めて Anypoint Exchange にパブリッシュされるのかをチェックします。仕様が初めてパブリッシュされる場合、API Designer は [API version (API バージョン)]​ 項目を有効にし、仕様でバージョン番号が指定されていないためバージョン番号を提案します。仕様のパブリッシュが初めてではない場合、API Designer は [API version (API バージョン)]​ 項目を有効にし、仕様が最後にパブリッシュされたときに使用された番号を項目に入力します。この番号は変更できます。

Was this article helpful?

💙 Thanks for your feedback!