Datenimport/-export Schnittstelle: Unterschied zwischen den Versionen
Aus HITGuard User Guide
Weitere Optionen
Faha (Diskussion | Beiträge) Keine Bearbeitungszusammenfassung |
Faha (Diskussion | Beiträge) |
||
| Zeile 17: | Zeile 17: | ||
:: Diese Option aktiviert die SwaggerUI, dabei handelt es sich um eine interaktive Beschreibung der REST Schnittstelle. Sie kann unter "/swagger" erreicht werden. Diese Seite ist nur für Entwickler relevant die mit der REST Schnittstelle kommunizieren möchten. Diese Option hat keine Auswirkung auf die Funktionalität der REST Schnittstelle. Wird sie deaktiviert, funktioniert die REST Schnittstelle, sofern sie aktiviert ist, trotzdem. | :: Diese Option aktiviert die SwaggerUI, dabei handelt es sich um eine interaktive Beschreibung der REST Schnittstelle. Sie kann unter "/swagger" erreicht werden. Diese Seite ist nur für Entwickler relevant die mit der REST Schnittstelle kommunizieren möchten. Diese Option hat keine Auswirkung auf die Funktionalität der REST Schnittstelle. Wird sie deaktiviert, funktioniert die REST Schnittstelle, sofern sie aktiviert ist, trotzdem. | ||
== | == Swagger / OpenApi Dokumentation == | ||
Version vom 17. Mai 2022, 13:17 Uhr
Konfiguration
Um die REST API zu aktivieren, muss in der Konfigurationsdatei "appsettings.json" folgendes Property gesetzt sein:
"RestApi": { "Enabled": true}
Einstellungen
Wurde die REST API im "appsettings.json" aktiviert, finden Administratoren einen neuen Bereich in den Globalen Einstellungen über den die REST API jederzeit aktiviert und deaktiviert werden kann.
- REST Schnittstelle aktivieren:
- Diese Option aktiviert die Endpunkte der REST Schnittstelle. Ist diese Option deaktiviert, dann nimmt die REST Schnittstelle keine Request entgegen.
- SwaggerUI aktivieren
- Diese Option aktiviert die SwaggerUI, dabei handelt es sich um eine interaktive Beschreibung der REST Schnittstelle. Sie kann unter "/swagger" erreicht werden. Diese Seite ist nur für Entwickler relevant die mit der REST Schnittstelle kommunizieren möchten. Diese Option hat keine Auswirkung auf die Funktionalität der REST Schnittstelle. Wird sie deaktiviert, funktioniert die REST Schnittstelle, sofern sie aktiviert ist, trotzdem.