Page tree
Skip to end of metadata
Go to start of metadata

Ab Nuclos 4.32.0 bietet der Webclient eine Swagger-UI Integration statt des REST Explorers.

Swagger-UI


REST Explorer

Der REST Explorer wird mit Nuclos mit 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
ArtBeschreibung
Installer

Webclient wird mit installiert

Installer

Installation als Entwicklungsumgebung

BerechtigungLogin im Webclient als Superuser

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!


Start des REST Explorer

Nach erfolgreichem Login im Webclient finden Sie im Menü Dev den REST Explorer vor.

 


Verwenden des REST Explorers

Auf der linken Seite werden die Services aufgelistet. Hier im Screenshot beispielhaft für die Version 4.4.4.

Nur gesicherte Services verwenden

Sie sollten nur die mit einem versehenen Services verwenden. Alle anderen sind noch nicht finalisiert und können sich in zukünftigen Versionen ändern oder auch entfallen!


Nach Auswahl eines Service werden im rechten Bereich die Details angezeigt. Diese unterteilen sich in

  1. URL
    häufig sind die Teile der URL parametrisiert, erkennbar an den geschweiften Klammern z.B. "{boMetaId}" und können bearbeitet werden.
  2. Request Parameter
    Im Regelfall ein JSON Objekt 
  3. Response
    Im Regelfall ein JSON Objekt  

Der Service /bos zeigt alle BOs, für die direkt eine Ergebnisliste abgerufen werden kann:

 bos

Durch klick auf z.B. den zweiten Link (http://localhost:8080/nuclos-war/rest/bos/example_rest_Order) gelangt man zur Ergebnisliste des BOs "example_rest_Order":

 bos/example_rest_Order

Der erste Link (http://localhost:8080/nuclos-war/rest/bos/example_rest_Order/40000308) dieser Liste zeigt nun einen vollständigen Detail Datensatz zur ausgewählten Order:

 bos/example_rest_Order/40000308


  • No labels