Versionen im Vergleich

Alte Version 1

changes.mady.by.user Ramin Göttlich

Gespeichert am

verglichen mit

Neue Version Aktuell

changes.mady.by.user Ramin Göttlich

Gespeichert am

Schlüssel

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

Nuclos Swagger UI: REST Explorer, OpenAPI, Superuser, environment.development, Try it out, boMetaId.

globe with meridians Sprache: Deutsch · English

hammer and wrench 1. Swagger-UI

Interaktiver REST-Explorer – Voraussetzungen, Aktivierung und Nutzung der Swagger-UI.

Status
colourPurple
titleHow-to
Status
colourBlue
titleEntwickler
Status
colourGreen
titleStand: Jul 2026
Status
colourGrey
titlegilt fuer Nuclos 4.2026.x

Panel
bgColor#F4F5F7

Auf dieser Seite

Inhalt
maxLevel2
minLevel

...

2

Die Swagger-UI wird

...

automatisch mit Nuclos installiert

...

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

Voraussetzungen

...

und gibt einen Überblick über alle bereitgestellten Services – ein idealer Einstieg und ein interaktiver Explorer.

Voraussetzungen

ArtBeschreibung
InstallerWebclient ist mitinstalliert.
InstallerInstallation als Entwicklungsumgebung.
BerechtigungLogin im Webclient als Super-User.
Info
titleProduktivumgebung

Auch in einer Produktivumgebung nutzbar: in NUCLOS_HOME/conf/system.properties

...

environment.development=true und environment.production=false setzen und Server neu starten (öffnet keine Entwicklungsports). Der nächste Installer-Lauf setzt dies zurück!

Aufruf

Nach dem Login im Webclient erscheint rechts im Menü das Symbol </>. Dort werden alle unterstützten Aufrufe angezeigt; nach Auswahl eines Service lassen sich parametrisierte URL-Teile (z.​B. {boMetaId}) bearbeiten und per Try it out direkt ausführen.

Verwandte Seiten

gear 3. Login

Login.

Öffnen →

gear RESTful Service

Überblick.

Öffnen →

" 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!ArtBeschreibungInstaller

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.

Image Removed

Verwenden der REST API über Swagger UI

hier werden alle Unterstützen Aufrufe angezeigt. 

Image Removed

 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

Image Removed

Try it out!!

Ein Login sieht dann so aus. 

Image Removed