Definition

Die Swagger-UI wird automatisch  mit  Nuclos installiert, ist also Teil von Nuclos selbst, und liefert einen groben Überblick über die von Nuclos zur Verfügung gestellten Services. Er ist daher ein idealer Einstieg in dieses Thema.

Alle auf diesen Seiten gezeigten beispielhaften Inhalte beziehen sich auf das Nuclet 2. Rest example.


Voraussetzungen

Wenn Sie in einer Produktivumgebung nachträglich das Property "environment.development" in den NUCLOS_HOME/conf/system.properties auf true setzen, und "environment.production" auf false, so wird nach einem Server Neustart ebenfalls der Explorer angeboten, ohne das Entwicklungsports geöffnet werden. Die anderen Voraussetzungen müssen aber auch dann erfüllt sein. Der nächste Installer Lauf setzt dies wieder zurück!

ArtBeschreibung
Installer

Webclient wird mit installiert

Installer

Installation als Entwicklungsumgebung

BerechtigungLogin im Webclient als Superuser

Start des REST Explorer

Nach erfolgreichem Login im Webclient finden Sie rechts im Menü </> den Swagger UI vor.

Verwenden der REST API über Swagger UI


hier werden alle Unterstützen Aufrufe angezeigt. 


 Nach Auswahl eines Service werden alle möglichen Aufrufe angzeigt.
  1. URL
    häufig sind die Teile der URL parametrisiert, erkennbar an den geschweiften Klammern z.B. "{boMetaId}" und können bearbeitet werden


Try it out!!

Ein Login sieht dann so aus.