Einführung in Swagger UI
Swagger UI ist ein interaktives Tool, mit dem Entwickler APIs direkt aus der Dokumentation visualisieren und testen können. Mit Swagger UI können Sie ganz einfach die Endpunkte der LMC-API erkunden, detaillierte Informationen zu den einzelnen Vorgängen anzeigen und sogar API-Aufrufe in Echtzeit ausführen.
1. Um zu beginnen, müssen Sie zunächst aus den Diensten denjenigen auswählen, der die erforderlichen Funktionen bereitstellt. Eine Liste aller Microservices finden Sie in den LMC-Systeminformationen:
2. Navigieren Sie zur Swagger-UI-Oberfläche, die in der Liste der Dienste verlinkt ist. Hier finden Sie ein benutzerfreundliches Layout, das alle verfügbaren Endpunkte zusammen mit ihren Parametern, Anforderungsmethoden und Antwortformaten anzeigt.
Sie können Ihre eigenen Daten eingeben und die Antworten sofort sehen, was diese Oberfläche zu einer unschätzbaren Ressource für das Testen und Verstehen der API-Funktionalität macht.
3. Klicken Sie auf apiKey und geben Sie Ihre API-Schlüssel-Anmeldedaten ein.
4. Klicken Sie auf „Close“.
5. Wählen Sie einen Endpunkt zum Testen aus und klicken Sie auf „Execute“.
6. Geben Sie anschließend die erforderlichen Parameter ein (accountId) und klicken Sie auf „Try it out“ (bereiten Sie diesen Schritt vor, bevor Sie das Token verwenden).
7. Bei Erfolg werden die Ergebnisse im Abschnitt „200“ angezeigt (nach unten scrollen).
