Versionen im Vergleich

Alte Version 13

changes.mady.by.user Inga Sertel

Gespeichert am

verglichen mit

Neue Version Aktuell

changes.mady.by.user Inga Sertel

Gespeichert am

Schlüssel

  • Diese Zeile wurde hinzugefügt.
  • Diese Zeile wurde entfernt.
  • Formatierung wurde geändert.

Inhalt
maxLevel2

Definition

Die Swagger-UI

REST Explorer

Der REST Explorer 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

ArtBeschreibungInstaller

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!

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

im Menü Dev den REST Explorer

rechts im Menü </> den Swagger UI vor.

 Image Removed

Image Added

Verwenden

des REST Explorers

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

Warnung
titleNur gesicherte Services verwenden

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

Image Removed

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

der REST API über Swagger UI


hier werden alle Unterstützen Aufrufe angezeigt. 


Image Added

 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
.
  • 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:

    Image Removed 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":

    Image Removed 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:

    Image Removed bos/example_rest_Order/40000308


    Image Added

    Try it out!!

    Ein Login sieht dann so aus. 


    Image Added