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

这篇博文旨在提醒与构建 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 团队

Discover more

기존 REST API 지원 중단 : 조치가 필요합니다

이 게시물은 YouTrack과의 외부 통합을 구축하는 기술적 측면에 대한 중요한 변경 사항과 더불어 YouTrack 관리자 및 팀의 외부 통합 설정을 담당한 책임자가 2021년 6월 말까지 취해야 하는 조치를 알려 드리기 위해 작성되었습니다.

무엇이 달라지나요?

2년 전, 새로운 REST API 리소스와 메서드를 점진적으로 게시하기 시작했음을 발표한 바 있습니다. 저희는 사용자들이 사용자 지정 통합을 효율적으로 구축할 수 있도록 새 API를 안전하고 유연하게 만드는 동시에 기존 API에서 겪고 있는 문제점을 해결하기 위해 최선을 다했습니다.

이제 새로운 REST API 기능이 릴리스 품질로 완전하게 지원되므로 기존 메서드 지원을 중단하고 이 새로운 API를 유지하고 개선하는 데 노력을 집중해야 할 때라고 생각합니다.

이에 따라 2021년 7월부터 전환을 시작하여 연말까지 작업을 마칠 계획입니다. 물론 기존 API를 완전히 중단하기 전에 모든 공식 라이브러리, 플러그인 및 위젯이 새 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로 통합을 마이그레이션하는 데 질문이 있거나 도움이 필요하면 지원 팀에 문의해 주세요. 언제든지 성의를 다해 도와드리겠습니다!

Your YouTrack team

이 게시물은 Anastasia Bartasheva가 작성한 Discontinuing the Legacy REST API: Action Required를 번역한 글입니다.

Discover more

News YouTrack

Прекращаем поддержку устаревшего REST API: что вам нужно сделать

Мы хотим напомнить о важных изменениях в технической стороне построения интеграций между YouTrack и внешними инструментами. До конца июня 2021 года администраторам YouTrack и тем, кто отвечает за настройку внешних интеграций, необходимо выполнить определенные действия.

Что меняется

Два года назад мы начали постепенно публиковать новые ресурсы и методы REST API. Мы постарались сделать новый API максимально безопасным и гибким, чтобы вы могли эффективно создавать собственные интеграции. Это также позволило нам избавиться от проблем, с которыми приходилось иметь дело в устаревшем API.

Теперь новый REST API полностью поддерживается, и мы хотим сосредоточиться на его улучшении. Поэтому пришло время прекратить поддержку устаревших методов.

Мы планируем начать переход в июле и завершить процесс к концу 2021 года. Мы, конечно же, переведем все наши официальные библиотеки, плагины и виджеты на новый API, прежде чем отключать устаревший.

Какие методы считаются устаревшими

Методы REST API в основном используются для создания интеграций между YouTrack и другими инструментами, чтобы получить дополнительную функциональность. Например, с помощью таких интеграций можно выгружать задачи из YouTrack и строить различные диаграммы на основе полученных данных. Если ваша команда пользуется такими интеграциями, найдите время посмотреть, какие методы там содержатся. В устаревших методах используется URL-префикс /rest, а в новых — /api.

Что нужно сделать

По завершении перехода нельзя будет использовать устаревший REST API в версиях YouTrack, выпущенных в июле 2021 года и позже. Все пользовательские интеграции, построенные на устаревших методах, тоже перестанут работать. Поэтому вам необходимо перевести весь свой код на новый REST API до июля 2021 года. С 1 июля 2021 года мы не сможем гарантировать, что устаревшие методы REST API будут работать.

В документации вы найдете подробные описания новых конечных точек, а также набор примеров, которые помогут вам ознакомиться с новым API.

Что будет с интеграциями

Мы понимаем, что в некоторых случаях наши пользователи не могут повлиять на интеграции с популярными инструментами, например с системами управления тестированием. Мы планируем связаться с разработчиками такого ПО: сообщим о предстоящих изменениях и предоставим всю необходимую помощь, чтобы эти интеграции точно были переведены на новый REST API.

Если у вас есть вопросы или вам нужна помощь с переводом интеграций на новый API, свяжитесь с нашей службой поддержки. Мы всегда рады помочь.

Ваша команда YouTrack
The Drive to Develop

Discover more

News YouTrack

Discontinuing the Legacy REST API: Action Required

This post is a reminder about important changes to the technical aspects of building external integrations with YouTrack, as well as the actions that YouTrack administrators and those in charge of setting external integrations for your teams must take by the end of June 2021.

What is changing?

Two years ago we announced that we had started to gradually publish new REST API resources and methods. We did our best to make the new API secure and flexible enough to allow our users to build custom integrations efficiently, while also addressing the pain points we dealt with in the legacy API.

The new REST API is now a fully supported, release-quality feature, and it’s time to discontinue the legacy methods, as we would like to concentrate our efforts on maintaining and enhancing this new API.

We are planning to start the transition in July 2021, and we intend to complete it by the end of the year. Of course, we will make sure all our official libraries, plugins, and widgets are migrated to the new API before switching the legacy one off.

What are the legacy REST API methods?

The YouTrack REST API methods are mostly used to build custom integrations between YouTrack and third-party tools, extending native YouTrack functionality. An integration could, for example, fetch issues from YouTrack and then build a custom chart based on the data.
If your team built any custom integrations, please take a moment to review them. The legacy methods are those that use the /rest URL prefix, while new methods are those that use /api instead.

Action required for our users

Once the transition has been completed, it will be impossible to use the legacy REST API on YouTrack versions released in July 2021 or later. All custom integrations that rely on the legacy REST API methods will stop working, as well. Please make sure to migrate all your custom code to the new REST API before July 2021 to avoid interruptions in your daily work. After July 1, 2021, we will no longer be able to guarantee that the legacy REST API methods will work.

The new REST API documentation provides detailed descriptions of new endpoints, and we also provide a set of ready-to-use examples that you can use to familiarize yourself with the new API.

What about YouTrack integrations with external tools?

We understand there are several YouTrack integrations that are widely utilized by our users but that cannot be affected by them – integrations with test management systems, for example. We are planning to contact representatives of these applications to communicate the upcoming changes and to provide all the help we can to make sure these integrations are migrated to the new REST API.

If you have any questions or need assistance with migrating your integrations to the new REST API, please contact our support team. We’re always happy to help!

Your YouTrack team

Discover more