Die YAML-Datei WebAdmin_REST-API.yaml stellt eine formale Beschreibung des REST-API dar und ist im installierten WebAdmin im Verzeichnis Docs, Unterverzeichnis REST-API zu finden.
Die Datei wurde unter Verwendung der Spezifikation OpenAPI v3 erstellt.
OpenAPI v3 ist ein Standard zur Beschreibung von REST-konformen Programmierschnittstellen.
Es wird empfohlen die YAML-Datei in den Editor (https://editor.swagger.io/) zu importieren:
"FILE" → "Import file" → "YAML Datei auswählen" → "Öffnen".
Diese Webseite erzeugt aus der deskriptiven Beschreibung eine ansprechende Dokumentation.
Alternativ kann, zur Erzeugung der benutzerfreundlichen Dokumentation, auch SwaggerUI eingesetzt werden, was jedoch mit einem deutlichen Mehraufwand verbunden ist.
Weitere Informationen: https://github.com/swagger-api/swagger-ui