API-Verträge
Aus Talend Cloud API Designer
Talend Cloud API Designer ist ein Modul der Talend-Plattform, das Teams bei der Erarbeitung und Dokumentierung ihres API-Vertrags unterstützt. Durch die eingebettete Integration von Talend Cloud API Designer in Talend Cloud API Tester ermöglicht Talend jederzeit eine Interaktion mit der in der Entwicklung befindlichen API. Der importierte Vertrag kann sich ebenfalls für das Bootstrapping von API-Tests ausgehend von einem bereits bestehenden Vertrag als überaus nützlich erweisen.
Swagger 2.0
Die Spezifikation des Swagger 2.0-Formats ist im Repository OpenAPI-Specification in GitHub verfügbar.
Zurzeit wird nur JSON unterstützt. Wenn Sie über ein YAML-Dokument verfügen, können Sie dieses vor dem Import in Talend Cloud API Tester problemlos in JSON konvertieren. Sie können beispielsweise den Online-Konverter JSON to YAML verwenden.
Die gesamte Swagger-Beschreibung wird in das neue Projekt importiert. In der nachstehenden Tabelle werden die beim Import erstellten Elemente beschrieben.
| Swagger-Element | Entsprechendes Element von Talend Cloud API Tester | Kommentare |
|---|---|---|
| API | Projekt | Ein Projekt mit allen konvertierten Swagger-Elementen. Name und Beschreibung des Projekts entsprechend Titel und Beschreibung der Swagger-API. |
| Pfad | Dienst | Jeder Pfad in Swagger wird in einen Dienst konvertiert. Der Dienst wird nach dem Basispfad des Swagger-Pfads benannt. |
| Operation | Request | Alle Operationen eines Swagger-Pfads werden in Requests konvertiert und in dem aus dem angegebenen Pfad extrahierten Dienst platziert. |