globe with meridians Language: Deutsch · English

hammer and wrench 1. Swagger UI

Interactive REST explorer – prerequisites, activation and use of the Swagger UI.

HOW-TO DEVELOPER UPDATED: JUL 2026 APPLIES TO NUCLOS 4.2026.X

On this page

The Swagger UI is installed automatically with Nuclos and gives an overview of all provided services – an ideal entry point and an interactive explorer.

Prerequisites

TypeDescription
Installerthe web client is installed as well.
Installerinstallation as a development environment.
Permissionlog in to the web client as a super user.

Production environment

Also usable in a production environment: set environment.development=true and environment.production=false in NUCLOS_HOME/conf/system.properties and restart the server (opens no development ports). The next installer run resets this!

Access

After logging in to the web client, the </> icon appears on the right of the menu. It shows all supported calls; after selecting a service you can edit parameterized URL parts (e.g. {boMetaId}) and run them directly via Try it out.

Related pages

gear 3. Login


Login.

Open →

gear RESTful service


Overview.

Open →

  • Keine Stichwörter