停用旧的 REST API,需要采取措施

Read this post in other languages:

这篇博文旨在提醒与构建 YouTrack 外部集成相关的重要技术变更,以及 YouTrack 管理员和负责为团队设置外部集成的人员在 2021 年 6 月底前必须采取的措施。

有什么变化?

两年前,我们宣布开始逐步发布新的 REST API 资源和方法。 我们竭尽全力使新 API 安全且灵活,让用户能够高效地构建自定义集成,同时解决旧 API 的痛点。

新 REST API 现已成为一项完全受支持并具备发布级质量的功能,现在是时候停用旧方法了,因为我们希望将精力放在维护和增强新 API 上。

我们计划在 2021 年 7 月开始过渡,并希望在年底之前完成。 当然,我们会确保先将所有官方库、插件和微件迁移至新 API,然后再停用旧版本。

什么是旧 REST API 方法?

YouTrack REST API 方法大多用于在 YouTrack 与第三方工具之间构建自定义集成,扩展原生 YouTrack 功能。 例如,集成的工具能够从 YouTrack 获取问题,然后基于数据构建自定义图表。

如果您的团队构建了任何自定义集成,请花点时间检查一下。 旧方法使用 /rest URL 前缀,而新方法则使用 /api

用户需要采取的措施

过渡完成后,将无法在 2021 年 7 月及以后发布的 YouTrack 版本上使用旧 REST API。 所有依赖旧 REST API 方法的自定义集成也将停止运行。 请确保在 2021 年 7 月之前将您的所有自定义代码迁移至新 REST API,以免您的日常工作出现中断。 2021 年 7 月 1 日后,我们将无法保证旧 REST API 方法可以运行。
新 REST API 的文档详细介绍了新端点,我们也将提供一组可以立即使用的示例来帮助您熟悉新 API。

YouTrack 与外部工具的集成呢?

我们深知有几项 YouTrack 集成被用户广泛使用,但他们却无计可施,例如与管理系统的集成。 我们计划联系这些应用程序的代表来沟通后续变更事宜,并提供力所能及的帮助以确保将这些集成迁移到新 REST API。

如果您有任何问题,或者需要协助来将您的集成迁移到新 REST API,请联系我们的支持团队。 我们将随时为您提供帮助!

您的 YouTrack 团队

image description

Discover more