Grundlagen der Bereitstellung von APIs
RGeschrieben vonRiku Virtanen Vor über einer Woche aktualisiertTable of contentsEinführung in die Bereitstellung von APIs
Genau wie Frends-Prozesse und -Unterprozesse werden Frends-APIs und ihre verknüpften Prozesse zunächst in der Entwicklungsumgebung erstellt und entwickelt. Um eine API in einer anderen Umgebung verwenden zu können, müssen Sie sie in der Zielumgebung bereitstellen.
Beim Bereitstellen einer API kann der Benutzer eine zuvor veröffentlichte Version bereitstellen oder eine neue veröffentlichte Version aus der aktuellen Entwicklungsversion erstellen. Im Bereitstellungsdialog kann der Benutzer sehen, welche Prozesse bereitgestellt werden, sowie die Swagger-Spezifikation. Wenn eine veröffentlichte Version nicht mehr gültig ist, beispielsweise weil ein verwendeter Prozess gelöscht wurde, kann sie nicht mehr bereitgestellt werden.
API-Versionskontrolle
Bevor wir auf die API-Bereitstellung eingehen, sehen wir uns an, wie die API-Versionierung in Frends funktioniert.
API-Versionen gibt es in zwei verschiedenen Zuständen. Die Version, die in der Entwicklungsumgebung angezeigt wird, ist immer dieaktuelle Entwicklungsversioneiner API. In allen anderen Umgebungen werden veröffentlichte Versionen angezeigt.
In Frends besteht eine API-Version immer aus der OpenAPI-Spezifikation und den Frends-Prozessen, die mit in der OpenAPI-Spezifikation definierten API-Operationen verknüpft sind.
Entwicklungsversion
Die Entwicklungsversion einer API ist eine Version, in der die verknüpften Prozesse keine gesperrten Versionen haben. Das bedeutet, dass der Benutzer jeden Prozess, der Teil der API ist, aktualisieren kann, ohne zusätzliche Aktionen ausführen zu müssen. Die OpenAPI-Spezifikation der Entwicklungsversion kann auch geändert werden. Wenn eine API zur Bereitstellung bereit ist, wird eine veröffentlichte Version erstellt.
Mit anderen Worten: Die OpenAPI-Spezifikation der API und die verknüpften Prozesse können nur in der Entwicklungsumgebung geändert werden.
Veröffentlichte Versionen
Wenn die OpenAPI-Spezifikation einer API und die verknüpften Prozesse zum Testen in der Testumgebung oder zur Bereitstellung in der Produktionsumgebung bereit sind, werden sie aus der Entwicklungsumgebung in der Zielumgebung veröffentlicht.
Eine veröffentlichte Version enthält alles, was eine Entwicklungsversion enthält, lässt aber keine Änderungen mehr zu. Durch die Veröffentlichung einer Entwicklungsversion der API werden die verwendeten verknüpften Prozessversionen gesperrt und die OpenAPI-Spezifikation kann nicht mehr geändert werden. Eine veröffentlichte Version kann als Einheit in einer Test- oder Produktionsumgebung bereitgestellt und auch zum Zurücksetzen der Entwicklungsversion auf eine frühere Version verwendet werden.
Der nächste Artikel istBeispiel für die Bereitstellung der aktuellen Entwicklungsversion einer API.
Verwandte ArtikelBeispiel zum Bereitstellen einer APIEinführung in die Bereitstellung Ihrer APIBeispiel für die Bereitstellung der aktuellen Entwicklungsversion einer APIBeispiel für die Bereitstellung einer zuvor veröffentlichten API-VersionBeispiel zum Aufheben der Verknüpfung entfernter API-Operationen