Kann ich die API mithilfe eines Explorers ansehen?
Der Webservice ist nicht nur statisch dokumentiert. Es gibt einen sogenannten Explorer (API Explorer), mit dem die API interaktiv angesehen werden kann.
Es wird empfohlen, über dieses Mittel nur einfache Anfragen auszuprobieren. Das tatsächliche Nachbilden von Software (was normalerweise während der Entwicklung gegen die API geschieht) findet besser über Entwicklungswerkzeuge statt. Wie ein Restclient oder curl. In dieser Anleitung wird davon ausgegangen, dass der Entwickler mit derartigen Hilfsmitteln vertraut ist.
Standort
Der API-Explorer ist über https://<UWDOMEIN>/api/rest/explorer/ erreichbar.
Im API-Explorer hat jede Hauptmethode (GET/POST/PUT/DELETE) ihre eigene Farbe. Jede Entität, jede Methode kann aufgeklappt werden. Weitere Dokumentation wird angezeigt, einschließlich einer Möglichkeit, die erforderliche Eingabe an die API zu übergeben.
Über die Schaltfläche Try it out wird die API des eigenen Systems aufgerufen.
Danach werden sowohl der Request als auch die Response angezeigt.
Logik / Business rules
Der Explorer arbeitet mit einem tatsächlichen System! Das bedeutet, dass sich der Explorer an das Benutzerniveau anpasst.
Siehe auch den Abschnitt Rechte in dieser Anleitung.
Die logische Konsequenz ist, dass zunächst nur öffentliche Methoden und Entitäten angezeigt werden. Methoden, für die Rechte angegeben werden müssen, sind dann unsichtbar.
Über denselben Explorer ist der Benutzer jedoch auch in der Lage, sich anzumelden und damit ein anderes Rechteniveau anzunehmen. Dies geschieht über die Entität /user.
Nach der Methode /user/login (und einem gültigen Passwort) erscheinen aller Wahrscheinlichkeit nach andere Methoden.
