Einführung in die Aktualisierung von API-Vorgängen

API-Entwicklung

RGeschrieben vonRiku Virtanen Vor über einer Woche aktualisiertTable of contents

Einführung in die Aktualisierung von API-Vorgängen

Während des Lebenszyklus einer API muss die Schnittstelle häufig geändert werden, wenn sich die Anforderungen ändern oder Tests ergeben, dass die Schnittstelle der API verbessert werden muss. In der Praxis wird die Schnittstelle der API geändert, indem die OpenAPI-Spezifikation der API geändert wird.

Schnittstellenänderungen in der OpenAPI-Spezifikation können eine oder mehrere der folgenden sein:

  • Änderung der bestehenden API-Operationen durch

    • Hinzufügen, Ändern oder Löschen von Operationsparametern

    • Änderung des Pfads der API-Operation

    • Änderung der Datenstruktur durch den API-Vorgang empfangen

    • Änderung der vom API-Vorgang zurückgegebenen Datenstruktur

    • Hinzufügen, Ändern oder Löschen von Rückgabecodes von API-Operationen (wie HTTP 200 – ok, HTTP 400 – ungültige Anfrage)

  • neue API-Operationen erstellen

  • Löschen Sie vorhandene API-Operationen.

Alle aufgeführten Änderungen wirken sich auf die API-Trigger geänderter API-Operationen aus und der API-Trigger muss auf die verknüpften Prozesse aktualisiert werden.

Der nächste Artikel istBeispiel zum Aktualisieren von API-Triggern der vorhandenen verknüpften Prozesse



Verwandte ArtikelEinführung in API TriggerEinführung in das Erstellen Ihrer ersten API und API-DefinitionEinführung in die API-TriggereinstellungenBeispiel zum Aktualisieren von API-Triggern der vorhandenen verknüpften ProzesseBeispiel zum Aufheben der Verknüpfung entfernter API-Operationen