集成指南 › BFC API 参考指南 › URL 构建 › API 分组和版本控制

API 分组和版本控制

在 URL 中使用应用前缀“BFC”将 BFC API 组合在一起。 在 URL 中，应用前缀紧跟在主机后面。

所有 API 均支持版本控制。 API 版本号与 API 本身（而非 BFC）相关。 因此，BFC 版本更改时，API 版本不必随之更改。 API 版本包括两部分：主版本号和次版本号。 API 的多个版本可以同时共存。 将在稍后确认停止版本支持的步骤，但是在仅更改 API 号的发行版中始终支持向后兼容性。 不同版本的有效负载记录可能有所不同。 用于标识 API 版本的 URL 也可标识记录版本。 记录本身不包含版本号。 但是，某些 API 可能选择在记录名称中包含版本。

BFC API 从 BFC 的 3.5.0 版本起可用。 API 的初始版本为 1.0。 客户端通过与明确的版本登录 URI 建立会话来请求 API 版本。 BFC 的每个版本对每个受支持的 API 版本支持一个明确的版本登录 URI。 除登录 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 错误。