Interaktive Swagger-Dokumentation

Zusammen mit der Intrexx Administration API wird eine Dokumentation im OpenAPI-Standard ausgeliefert. Diese wird von einer Swagger-UI-Kompomente dargestellt. Diese Dokumentation ist interaktiv, so dass Sie mit ihr die Intrexx Administration API kennenlernen und testen können.

Detaillierte Informationen zu Swagger finden Sie unter folgendem Link: https://swagger.io/

Interaktive Swagger-Dokumentation aktivieren

Setzen Sie das Attribut "DebugMode" in der Datei "admin-api.yaml" auf "true".

Die Datei "admin-api.yaml" finden Sie unter folgendem Pfad:

<intrexx-installationsverzeichnis>\admin-api\cfg\
```
environment:
  …
  …
debugMode: true
maxAuthRequestPerIP: 50
```
Starten Sie die Intrexx Administration API neu.

Vergleichen Sie hierzu Abschnitt Intrexx Administration-API starten.
Rufen Sie in einem Browser die folgende URL auf:

<Host-ULR>:4242/documentation

Beispiel

https://localhost:4242/documentation

Wenn Sie bei der Installation der IAA nicht den Standard-Port 4242 gewählt haben, müssen Sie in der URL den Port entsprechend anpassen.