Legacy-REST-API wird eingestellt: Aktion erforderlich
Dieser Beitrag ist eine Erinnerung an wichtige Änderungen bei den technischen Aspekten der Erstellung externer Integrationen mit YouTrack sowie an die Maßnahmen, die YouTrack-Administrator*innen und diejenigen, die für die Einstellung externer Integrationen für Ihre Teams verantwortlich sind, bis Ende Juni 2021 ergreifen müssen.
Was ändert sich?
Vor zwei Jahren haben wir angekündigt, dass wir damit begonnen haben, nach und nach neue REST-API-Ressourcen und -Methoden zu veröffentlichen. Wir haben unser Bestes getan, um die neue API sicher und flexibel genug zu machen, damit unsere Benutzer*innen benutzerdefinierte Integrationen effizient erstellen können. Gleichzeitig haben wir die Problempunkte adressiert, die wir in der alten API hatten.
Die neue REST-API ist nun ein vollständig unterstütztes, releasefähiges Feature. Es ist jetzt die Zeit, die Legacy-Methoden einzustellen, da wir unsere Bemühungen auf die Pflege und Verbesserung dieser neuen API konzentrieren möchten.
Wir planen, mit der Umstellung im Juli 2021 zu beginnen, und wir beabsichtigen, sie bis zum Ende des Jahres abzuschließen. Natürlich werden wir sicherstellen, dass alle unsere offiziellen Bibliotheken, Plugins und Widgets auf die neue API migriert werden, bevor wir die Legacy-API abschalten.
Was sind die Legacy-REST-API-Methoden?
Die YouTrack REST-API-Methoden werden hauptsächlich dazu verwendet, kundenspezifische Integrationen zwischen YouTrack und Tools von Drittanbietern zu erstellen, die die native YouTrack-Funktionalität erweitern. Eine Integration könnte zum Beispiel Tickets von YouTrack abrufen und dann ein benutzerdefiniertes Diagramm auf Basis der Daten erstellen. Wenn Ihr Team benutzerdefinierte Integrationen erstellt hat, nehmen Sie sich bitte einen Moment Zeit, um diese zu überprüfen. Die Legacy-Methoden sind diejenigen, die das URL-Präfix /rest verwenden, während die neuen Methoden diejenigen sind, die stattdessen /api verwenden.
Erforderliche Maßnahmen für unsere Benutzer*innen
Sobald die Umstellung abgeschlossen ist, wird es nicht mehr möglich sein, die Legacy-REST-API auf YouTrack-Versionen zu verwenden, die im Juli 2021 oder später veröffentlicht werden. Alle benutzerdefinierten Integrationen, die auf die Legacy-REST-API-Methoden angewiesen sind, werden ebenfalls nicht mehr funktionieren. Bitte stellen Sie sicher, dass Sie Ihren gesamten benutzerdefinierten Code vor Juli 2021 auf die neue REST-API migrieren, um Unterbrechungen in Ihrer täglichen Arbeit zu vermeiden. Nach dem 1. Juli 2021 können wir nicht mehr garantieren, dass die Legacy-REST-API-Methoden funktionieren werden.
Die neue REST-API-Dokumentation enthält detaillierte Beschreibungen der neuen Endpunkte, und wir stellen auch eine Reihe von gebrauchsfertigen Beispielen zur Verfügung, mit denen Sie sich mit der neuen API vertraut machen können.
Was passiert mit YouTrack-Integrationen mit externen Tools?
Wir wissen, dass es einige YouTrack-Integrationen gibt, die von unseren Benutzer*innen häufig genutzt werden, die aber nicht beeinflusst werden können – Integrationen mit Testmanagementsystemen zum Beispiel. Wir planen, die Vertretung dieser Anwendungen zu kontaktieren, um die bevorstehenden Änderungen zu kommunizieren und jede Hilfe zu leisten, um sicherzustellen, dass diese Integrationen auf die neue REST-API migriert werden.
Wenn Sie Fragen haben oder Unterstützung bei der Migration Ihrer Integrationen auf die neue REST-API benötigen, wenden Sie sich bitte an unser Support-Team. Wir helfen Ihnen jederzeit gerne!
Ihr YouTrack-Team
Subscribe to YouTrack Blog updates
