阅读文档公共API

最近,我们修改了Read the Docs的公共API。之前,我们的构建过程使用了最新的API(v2)但没有被外部用户大量使用。

作为这个过程的一部分,我们努力确保API易于使用访问“阅读文档”项目,生成、和版本,更容易按特定项目筛选生成和版本,而且那个文档是最新的。

弃用API v1并通过不安全的HTTP进行连接

作为这个过程的一部分,我们正式反对对我们的API v1.一定会的至少支持到2019年1月1日但我们强烈建议所有用户尽早迁移到API v2。

此外,API v1和API v2都允许通过不安全的HTTP进行连接与HTTPS相反。从2019年1月开始,我们将通过HTTP将请求重定向到HTTPS。这将提高安全性,并允许我们向API添加更多与安全相关的功能。对于大多数用户来说,这应该是连接到API的HTTPS版本的单行更改。

联系

当数据被公开共享时,我们总是对人们创造的惊人事物感兴趣。此外,我们一直在寻求改进我们的API,以支持更多项目和mashup。如果您在项目中使用Read the Docs的公共API或者您希望在其中看到其他功能,我们很乐意收到你的来信.