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.
Der REST Explorer ist aktiv, wenn das Property "environment.development" in den system.properties auf true gesetzt ist.
Alle auf diesen Seiten gezeigten beispielhaften Inhalte beziehen sich auf das Nuclet 2. Rest example.
Voraussetzungen
| Art | Beschreibung |
|---|---|
| Installer | Webclient wird mit installiert |
| Installer | Installation als Entwicklungsumgebung |
| Berechtigung | Login im Webclient als Superuser |
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 befinden sich die Services. 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
- URL
häufig sind die Teile der URL parametrisiert, erkennbar an den geschweiften Klammern z.B. "{boMetaId}" und können bearbeitet werden. - Request Parameter
Im Regelfall ein JSON Objekt - Response
Im Regelfall ein JSON Objekt
Der Service /bos zeigt alle BOs, für die direkt eine Ergebnisliste abgerufen werden kann:
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":
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
Überblick
Inhalte