Swagger Online Dokumentation

Die Swagger UI kann zum Testen der Zugriffe und als Dokumentation der API genutzt werden.

Mit folgendem Befehl kann die Swagger UI gestartet werden:

Request body:

http://localhost:8180/api/startDebug

Start des Swaggers

Zum Starten von Swagger wird der API-Dienst im Hintergrund neu gestartet. Dies kann einige Sekunden dauern.
Es erfolgt eine automatische Weiterleitung auf die Startseite von swagger-ui.
Nach dem erfolgreichen Start ist die Seite über den folgenden Link erreichbar: <servername>/swagger-ui.html#/eco-dms-rest-controller
Eine ausführliche Anleitung zur Verwendung von Swagger kann auf der Webseite des Projektes aufgerufen werden: https://swagger.io/

Stop des Swaggers

Sofern der API-Port produktiv genutzt wird oder für jeden erreichbar ist, ist es sinnvoll Swagger zu stoppen.
Die Swagger-Oberfläche wird mit folgendem Aufruf gestoppt: localhost:8180/api/stopDebug
Zum Stoppen von Swagger wird der API-Dienst im Hintergrund neu gestartet. Dies kann einige Sekunden dauern.

Verwandte Artikel