Swagger, auch unter dem Namen OpenAPI bekannt, stellt eine sprachunabhängige Spezifikation für das Beschreiben von REST-APIs dar. Es unterstützt Entwickler dabei, die Funktionen eines Service zu verstehen, indem eine interaktive Dokumentation und Hilfeseiten für die Web-API erstellt werden.
Seite ArcGIS Earth Automation API
Die ArcGIS Earth Automation API verwendet das Open-Source-Projekt Swashbuckle.AspNetCore, um Swagger-Dokumente zu generieren, die Swagger-UI zu implementieren und auf diese Weise eine webbasierte UI mit hilfreichen Informationen bereitzustellen.
Nach der Aktivierung der ArcGIS Earth Automation API finden Sie den Swagger-Link in den erweiterten Anwendungseinstellungen. Die Standard-URL lautet http://localhost:8000/swagger/index.html.
Die Swagger-UI sieht folgendermaßen aus:
Sie können jede Methode für öffentliche Aktionen im Controller über die Swagger-UI testen.
- Klicken Sie auf einen Methodennamen, um den Abschnitt zu erweitern.
- Klicken Sie auf Try it out.
- Fügen Sie ggf. erforderliche Parameter hinzu.
- Klicken Sie auf Execute.