API v3现已稳定

我们很高兴地宣布API v3已达到稳定释放,现在,所有Read the Docs用户都可以使用。自从我们宣布API v3测试版,我们一直在根据用户反馈添加额外的功能和bug-fixing小问题。

新API v3不是API v2的完全替代品,但是我们强烈建议对所有新集成使用API v3.API v2将很快被弃用,尽管我们没有一个明确的折旧时间表。当我们这样做时,我们将提醒用户我们的计划。

新功能

我们对API v3实现的以下操作感到兴奋:

  • 导入新项目

  • 激活版本

  • 触发器生成

  • 检查生成状态

  • 管理重定向

API v3允许您轻松管理Read the Docs项目和组织中的常见任务。其中包括:

  • 为新项目设置文档

  • 自动发布新版本

  • 如果检测到失败的构建,则暂停发布

  • 自动为更改文件创建重定向

如果你想了解更多,请查看完整的APIv3文档.

帮助我们做得更好

我们总是喜欢听到用户如何使用API。我们希望帮助您以最简单、最高效的方式管理文档。请随时在问题跟踪器中打开问题如果有一个用例我们没有涵盖。