Beispiel zum Bereitstellen einer API

Bereitstellen von APIs

Aleksi Hytönen avatarGeschrieben vonAleksi Hytönen Vor über einer Woche aktualisiertTable of contents

So stellen Sie eine API bereit

Um die API nutzen zu können, muss sie bereitgestellt werden. Zu diesem Zweck benötigen Sie Informationen über die Agentengruppe, in der die API und die zugehörigen Prozesse bereitgestellt werden.

Im ersten Schritt der API-Bereitstellungsansicht können Sie die Informationen überprüfen und alle relevanten Hinweise zur Bereitstellung angeben. Im zweiten Schritt wählen Sie die Ziel-Agentengruppe für die Bereitstellung aus und wählen die Prozessversionen aus, die bereitgestellt werden sollen.

Nachdem die API bereitgestellt wurde, wird sie in der API-Listenansicht der Agentengruppe angezeigt und der Trigger wird aktiviert.

Entwicklungsversionen

Eine Entwicklungsversion einer API ist eine Version, bei 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. Darüber hinaus kann die Swagger-Spezifikation der Entwicklungsversion geändert werden. Sobald eine API zur Bereitstellung bereit ist, besteht der nächste Schritt darin, eine veröffentlichte Version zu erstellen.

Veröffentlichte Version

Eine veröffentlichte Version enthält alles, was eine Entwicklungsversion enthält, aber Änderungen sind nicht zulässig. Die API Swagger-Spezifikation und die von der API verwendeten Prozesse sind eingefroren. Eine veröffentlichte Version kann als Einheit bereitgestellt und auch als Version zum Zurücksetzen der Entwicklungsversion verwendet werden.

Beim Bereitstellen kann der Benutzer wählen, ob er eine zuvor veröffentlichte Version bereitstellen oder aus der aktuellen Entwicklungsversion eine neue veröffentlichte Version erstellen möchte. Im Bereitstellungsdialog kann der Benutzer die Prozesse anzeigen, die bereitgestellt werden, sowie die Swagger-Spezifikation. Wenn eine veröffentlichte Version nicht mehr gültig ist, beispielsweise aufgrund eines gelöschten Prozesses, kann sie nicht bereitgestellt werden.

Der nächste Artikel istEinführung in die Konfiguration einer Authentifizierungsmethode für eine API


Verwandte ArtikelBereitstellen von ProzessenEinführung in die Bereitstellung Ihrer APIEinführung in die Bereitstellung von APIs und die API-VersionskontrolleBeispiel für die Bereitstellung der aktuellen Entwicklungsversion einer APIBeispiel für die Bereitstellung einer zuvor veröffentlichten API-Version