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.

Auf dieser Seite

Die Swagger-UI wird automatisch mit Nuclos installiert 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.

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 →