1. Homepage
  2. API Experience Hub

  3. API Experience Hub での API バージョン設定

API Experience Hub での API バージョン設定

テキストの変更など、API 仕様に互換性を破らない変更が必要になった場合、これらの変更はパッチバージョン変更として行われます (例: バージョン ​3.0.0​ からバージョン ​3.0.1​)。API Experience Hub は、これらの更新を自動的に、API がパブリッシュされているすべてのポータルに直ちにインポートします。API Experience Hub ポータル管理者によるアクションは不要です。

API バージョンに対するメジャー更新

現在のバージョンとの互換性がない API の新バージョンが作成されたら、API Experience Hub ポータル管理者は、新しいバージョンをサイトでパブリッシュするタイミングと方法をコントロールします。新しいバージョンは表示なしで API エディションモーダルに表示され、コミュニティでは誰もこの API 情報にアクセスできません。管理者は古い API バージョンと新しい API バージョンに対する表示を設定できます。

たとえば、API チームの開発者が API に新しいリソースを追加したとします。

  1. 開発者は、Design Center で API を開いて、仕様にリソースを追加してから ​[Publish to Exchange (Exchange にパブリッシュ)]​ をクリックします。

  2. この変更は互換性を破るため、開発者は [Publish API specification to Exchange (Exchange に API 仕様をパブリッシュ)] の [API version (API バージョン)] 情報を変更します。

    たとえば、[API version (API バージョン)] が v3 であれば、v4 に変更します。[Asset version (アセットバージョン)] が 3.0.1 であれば、4.0.0 に変更します。[Name (名前)] と [Main file (メインファイル)] は変更しません。

  3. 開発者は ​[Publish (パブリッシュ)]​ をクリックします。

  4. 以前の API バージョンは、パブリッシュされているすべてのポータルにそのまま残ります。

ポータル管理者は、変更内容を確認してパブリッシュする必要があります。

  1. API Experience Hub で、[API Management (API 管理)] に移動します。

    API は引き続き ​[APIs in the portal (ポータルの API)]​ に表示されます。新しいバージョンの表示は [None (なし)] になります。

  2. API 名の横にあるその他のオプションアイコンをクリックします。

  3. 表示を ​[Administrators only (管理者のみ)]​ に変更します。

  4. [Preview in Salesforce Builder (Salesforce ビルダーでプレビュー)]​ をクリックして API を確認します。

  5. [API Management (API 管理)] に移動します。

  6. API 名の横にあるその他のオプションアイコンをクリックします。

  7. 新しいバージョンの表示を変更します。

    新しいバージョンを誰にでも公開する場合は ​[Administrators only (管理者のみ)]​ を ​[Everyone (全員)]​ に変更し、ログインしたメンバーにのみ表示する場合は [Members only (メンバーのみ)] に変更します。

    表示が [Everyone (全員)] または [Members only (メンバーのみ)] である場合、コンシューマー開発者は、新しい API バージョンをポータルの API Carousel (API カルーセル) で表示できるようになります。