Hier lesen

Wichtig:

Wir planen, die Orchestrator Swagger-Version auf Swagger 3.0 zu aktualisieren. Derzeit werden Orchestrator-APIs mit Swagger 2.0 definiert.

Machen Sie sich keine Sorgen über die Abwärtskompatibilität mit Ihren vorhandenen API-Clients: Wir stellen sicher, dass die API kompatibel bleibt.

Wir empfehlen, Ihre vorherigen Clients zu verwenden, da JSON-Änderungen sie dank unserer Abwärtskompatibilität der Anforderungsstruktur nicht ändern.

Nach dem Swagger 3.0-Update müssen alle neu generierten API-Clients, die auf der neuen JSON-Definition basieren, neu angepasst werden.

Wenn Sie vorhaben, unsere APIs in Ihren Client zu integrieren, müssen Sie sich der möglichen Aktualisierungen und Änderungen bewusst sein, die an der Swagger-Definition, JSON-Schemas oder API-Endpunkten vorgenommen werden können.

Die folgende Liste enthält Informationen und Empfehlungen zu Swagger-Änderungen. Wenn Sie weitere Fragen haben, wenden Sie sich an unser Support-Team.

Informationen und Empfehlungen zu Swagger-Änderungen

1. Die im Swagger-JSON-Dokument dargestellte JSON-API-Beschreibung kann sich jederzeit ändern. Es wird jedoch dieselbe zugrunde liegende API beschrieben, um die Abwärtskompatibilität sicherzustellen.
2. Die Swagger-Schnittstelle und die entsprechende JSON werden basierend auf den aktuellen Endpunkten generiert, und wir veröffentlichen immer die neueste Version. Um die Abwärtskompatibilität zu gewährleisten, unterstützen wir dieselbe Anforderungsstruktur.
3. Als Alternative zu laufzeitgenerierten API-Clients verwenden Sie API-Clients mit fester oder Kompilierzeit. Dadurch wird die Abhängigkeit reduziert und größere Automatisierungsaktualisierungen verhindert, falls sich die API- oder Swagger-Definition ändert.
4. Als veraltet markierte Elemente sind für eine begrenzte Zeit verfügbar. Danach werden die Elemente aus der Swagger-Definition und der JSON-API entfernt.
5. Immer wenn sich bestimmte APIs intern ändern, wird eine neue Swagger-API-Version veröffentlicht. Die API-Versionsnummer hat keinen Einfluss auf die Verwendung der Client-API. Wir empfehlen, sich nicht auf die API-Versionsverwaltung zu verlassen.

API-Beispiele

Die Beispiele im vorhandenen Orchestrator-Referenzdokument beschreiben komplexe Szenarien und Endpunkte.

Sie können alle verfügbaren APIs in der Swagger-JSON sehen, die die neuesten Updates enthält.