API

Entwickler können über programmatische Anfragen mit dem Webdienst arbeiten; die Schnittstelle ist nach gängigen Standards zur API-Beschreibung dokumentiert. Sie entspricht der Spezifikation OpenAPI Version 3 und bietet eine Swagger-Oberfläche für Entwicklung und Debugging.

Allgemeine API-Beschreibung: Die OpenAPI-Spezifikation beschreibt Ihre API klar und nachvollziehbar, einschließlich der verfügbaren Endpunkte, Methoden (GET, POST, PUT, DELETE und weitere), Abfrageparameter, Header, Antwortcodes und Datentypen.

Aufbau der Spezifikation:

• Version: gibt die Version der Spezifikation an.
• Info: enthält Metadaten zu Ihrer API, etwa Name, Version und Beschreibung.
• Host und Basispfad: geben die Basis-URL und den Kontextpfad der API an.
• Endpunkte: beschreiben jede verfügbare API-Ressource, ihre Methoden sowie mögliche Parameter und Antworten.

Swagger UI bietet eine grafische Oberfläche, in der Sie die API erkunden, die verfügbaren Endpunkte einsehen und Testanfragen direkt im Browser ausführen können. Sie geben die erforderlichen Parameter ein, senden Anfragen und sehen sich die Antworten an. So lässt sich die Funktionsweise der API leichter nachvollziehen und testen. Wird die API-Spezifikation aktualisiert, übernimmt Swagger UI die Änderungen automatisch.