Swagger
Swagger
Im swagger sind alle API-Endpunkte grafisch dargestellt und testbar.
Swagger ist erreichbar unter: <Protokoll>://<CmiApiServer>:<Port>/<Mandant>/swagger/index.html
Swagger einer Gruppe ist erreichbar unter: <Protokoll>://<CmiApiServer>:<Port>/<Mandant>/groups/<Gruppenname>/swagger/index.html
Alle Endpunkte sowie Models sind in Swagger beschrieben. Jeder Endpunkt lässt sich testen, indem dieser aufgeklappt und auf "Try it out" gedrückt wird. Anschliessend müssen die notwendigen Parameter ausgefüllt werden.
In Swagger sind mehrere Definitionen vorhanden, welche über das Dropdown ausgewählt werden können:
- CMI-API Model: Swaggerdefinition für die generische API mit den ausgewählten Typdefinitionen
- CMI-API Debug: Swaggerdefinition für debugging-Endpunkte wie zum Beispiel "Logging"
- CMI-API Process*: Swaggerdefinition für die Prozess-Layer. Jeder Layer hat dabei seine eigene Definition.
Authentifizierung
Damit die API verwendet werden kann, braucht es ein Token. Wenn man ein Bearer Token beim STS bezogen hat, so kann unter "Authorize" dieses Token eingefügt werden. - STS 3 (Beispielkonfiguration-STS-3.pdf)
Achtung! Vor dem Token muss zwingend "Bearer" stehen.
OpenAPI Definition
Über Swagger kan man sich auch ein OpenAPI Json-File generieren. Dies erreicht man indem man das swagger.json öffnet:
Über den Swagger-Editor (www.editor.swagger.io) kann man sich diverse Clients generieren lassen.