レガシー REST API の廃止について：要対応
この記事では、YouTrack との外部連携に関する重要な技術的変更のほか、YouTrack 管理者とチームの外部連携設定を担当している方が 2021 年 6 月末までに実施すべき対応を掲載しています。
変更内容
JetBrains は 2 年前に新しい REST API のリソースとメソッドを段階的にリリースすることを発表しました。 私たちは最善を尽くして新しい API の安全性と柔軟性を確保し、ユーザーが効率よく独自の連携を行い、既存 API で解消された問題点に対処できるようにしました。
新しい REST API がついにリリース可能な品質になり、完全にサポートされるようになりました。また、この新しい API のメンテナンスと強化に注力するため、既存のメソッドを廃止することになりました。
移行期間は 2021 年 7 月から開始し、年末までには終了する予定です。 当然ながら、公式のライブラリ、プラグイン、ウィジェットについては、既存の API を廃止する前にすべて新しい API に確実に移行する予定です。
レガシー REST API メソッドとは？
YouTrack REST API のメソッドは主に YouTrack やサードパーティツールと独自の連携を行い、YouTrack 本来の機能を強化する目的で使用されています。 例えば、YouTrack から課題を取得し、そのデータを元に独自のチャートを作成するといった連携を行うことができます。 あなたのチームがカスタムの連携を行っている場合は、レビューが必要です。 レガシーメソッドが使用している URL のプレフィックスは /rest ですが、新しいメソッドは /api を代わりに使用しています。
ご対応いただく内容
移行期間が終了した後、2021 年 7 月以降にリリースされる YouTrack のバージョンではレガシー REST API を使用できなくなります。 同様に、既存の REST API メソッドを使用している独自連携ロジックもすべて機能しなくなります。 日常業務への影響を避けるため、すべての独自コードを必ず 2021 年 7 月より前に新しい REST API に移行してください。 2021 年 7 月 1 日以降は、レガシー REST API メソッドの動作は一切保証できません。
新しい REST API のドキュメントに新しいエンドポイントの詳細な説明を掲載しています。また、新しい API に慣れていただくために既製のサンプルも用意しています。
YouTrack と外部ツールとの連携について
JetBrains はユーザーが幅広く利用しているものの、影響を受けない YouTrack との連携機能がいくつか存在することを把握しています。例えば、テスト管理システムとの連携機能などがあります。 JetBrains は該当する連携機能を確実に新しい REST API に確実に移行できるよう、該当するアプリケーションの担当者に今後の変更予定を共有し、全面的に協力する予定です。
ご質問がある場合や新しい REST API への移行に関して支援が必要な場合は、サポートチームにお問い合わせください。 いつでもお手伝いします！
YouTrack チーム一同より
