前のトピック: エンコーディング

次のトピック: デザイン パターン


API のグループ化およびバージョン管理

BFC API は、URL でアプリケーション プレフィックス「BFC」を使用してグループ化されます。 アプリケーション プレフィックスは、URL 内でホストの直後に配置されます。

すべての API はバージョン管理をサポートしています。 API のバージョン番号は、BFC ではなく、API 自体に関連するものです。 したがって、BFC のバージョンが変更された場合に API のバージョンを変更する必要はありません。 API のバージョンには、メジャー番号とマイナー番号という 2 つの部分があります。 API の複数のバージョンが同時に共存できます。 バージョンのサポートを中止するための手順は後で説明します。しかし、API 番号のみが変更されるリリースでは後方互換性がなくなることはありません。 ペイロード レコードはバージョン間で変更される場合があります。 API バージョンの識別に使用する URL によって、レコードのバージョンも識別できます。 レコード自体にはバージョン番号は含まれません。 ただし、一部の API では、レコード名にバージョンを含めることができます。

BFC API が最初に使用可能になるのは、BFC の 3.5.0 リリースです。 最初の API バージョンは 1.0 です。 クライアントが API のバージョンをリクエストするには、明示的なバージョン ログイン URI でセッションを確立します。 BFC のすべてのバージョンで、サポートされている各 API バージョンに対する明示的なバージョン ログイン URI をサポートしています。 ログイン以外の URI には明示的なバージョン番号は含まれません。

初期リリース用の URL の例

https://<bfchost>:8443/BFC/1.0/login
https://<bfchost>:8443/BFC/...

たとえば、BFC の将来のリリースにグリッド API への変更が含まれ、さらに 1.0 API のサポートの続行が望まれる場合には、新バージョンで以下の URL をサポートします。

https://<bfchost>:8443/BFC/1.0/login
https://<bfchost>:8443/BFC/1.1/login
https://<bfchost>:8443/BFC/grids/...

1.1 バージョンには 1.0 に存在しなかった新しい API が含まれる可能性があり、その場合には次の新しい URL が導入される場合があることに注意してください。

https://<bfchost>:8443/BFC/servers/...

1.0 URI にログインしたクライアントは新しいサーバ URI にアクセスできません。アクセスしようとすると、HTTP 404 エラーが返されます。