帮助中心
所有文章
使用指南
API 版本
最后更新于 2022/11/16   阅读数 223

订阅蜂 REST API 是版本控制的。版本控制确保订阅蜂 REST API 更改向后兼容。订阅蜂使用主和次要版本命名法来管理更改。通过在REST请求中指定一个版本,您可以获得预期的响应,而不管API将来如何更改。

主要版本

订阅蜂 REST API 的主版本号显示在REST URL中。目前,订阅蜂只支持v1主版本。例如https://rest.dingyuefeng.com/v1/quotes.

次要版本

订阅蜂使用 REST API 的次要版本来控制小的更改。例如,失效一个字段,并使用新字段来替换它。

REST方法中的某些字段是在次要版本中支持的。如果某个字段未标注次要版本,则此字段可用于所有次要版本。如果某个字段带有次要版本,则该字段处于版本控制中。您必须在请求标头中指定受支持的次要版本,以便在没有错误的情况下进行处理。

如果某个字段处于版本控制中,则该字段要么具有最小次要版本,要么具有最大次要版本,或者两者都具有。只能在次要版本介于最小和最大次要版本之间的情况下使用此字段。

如果在请求头中指定了不受支持的版本号,订阅蜂将使用REST API的最小次要版本。在我们的RESTAPI文档中,如果字段或功能需要次要版本号,我们会在字段描述中注释。

当使用需要次要版本的字段时,只需指定版本号。要指定次要版本,请将bee-version参数设置为请求调用的请求头中的次要版本号。请在请求标头中将bee-version版本参数设置具体的版本号。

对于所有REST API字段,默认情况下,如果在请求头中未指定次要版本,订阅蜂将使用REST API的最小次要版本,以避免破坏您的集成。

本篇目录

主要版本

次要版本