Beispiel zum Finden und Verwenden der Swagger-Benutzeroberfläche

Navigieren in der Swagger-Benutzeroberfläche

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

So finden Sie die Swagger-Benutzeroberfläche

Um Swagger UI zum Testen Ihrer APIs zu verwenden, navigieren Sie zur API-Listenansicht und wählen Sie die entsprechende API aus der Liste aus. Klicken Sie dort auf die Schaltfläche API Specification UI, um auf Swagger UI zuzugreifen. Diese webbasierte Schnittstelle gilt allgemein als Standardtool für API-Tests und bietet eine intuitive Möglichkeit zum Testen von APIs.

Beachten Sie, dass ein aktiver Auslöser vorhanden sein muss, damit die Schaltfläche aktiviert werden kann.

So verwenden Sie die Swagger-Benutzeroberfläche

Frends verwendet die Standard-Swagger-Benutzeroberfläche, die Sie über derenOnline-Demofalls du Interesse hast.

Der genaue Inhalt, der in der Swagger-Benutzeroberfläche angezeigt wird, hängt von Ihrer API ab. Der Hauptzweck der Swagger-Benutzeroberfläche besteht darin, alle API-Endpunkte, die von ihnen verbrauchten Daten und die Erträge anzuzeigen. Sie können damit auch Aufrufe an diese Endpunkte ausführen. Die Aufrufe werden tatsächlich getätigt und starten die entsprechenden Frends-Prozesse wie gewohnt.

Wenn ein API-Schlüssel erforderlich ist, aber nicht im Autorisierungsheader eingerichtet wurde, wird vor dem Zugriff auf die Swagger-Benutzeroberfläche ein Fenster angezeigt.

Über die Schaltfläche „Ausprobieren“ können Sie Aufrufe Ihrer API-Endpunkte ausführen. Über diese Schaltfläche können Sie bei Bedarf die Nutzlast der Anfrage bearbeiten. Darunter können Sie die Antworten einsehen, die die API je nach Spezifikation zurückgeben kann.

Wenn alles richtig aussieht, können Sie auf die Schaltfläche „Ausführen“ klicken. Nach der Ausführung sendet Swagger UI eine Anfrage von Ihrem Computer und zeigt das Ergebnis zusammen mit einem Curl-Befehl an, der zeigt, was tatsächlich gesendet wurde.

Der nächste Artikel istEinführung in die OpenAPI-Spezifikation


Verwandte ArtikelAPI-VerwaltungZugriff auf die Verwaltungs-API mit Swagger UIEinführung in das Testen einer API und API – SchlüsselkonzepteEinführung in die Bereitstellung Ihrer APIEinführung in die API-Spezifikation So verwenden Sie den Swagger Editor