Swagger, zwanym również interfejsem OpenAPI, jest niezależną od języka specyfikacją opisującą interfejsy REST API. Pomaga ona deweloperom zrozumieć możliwości usługi przez generowanie interaktywnej dokumentacji i stron pomocy dla internetowego interfejsu API.
Strona ArcGIS Earth Automation API
Interfejs ArcGIS Earth Automation API wykorzystuje projekt typu Open Source o nazwie Swashbuckle.AspNetCore do wygenerowania dokumentów Swagger i zaimplementowania interfejsu użytkownika Swagger w celu udostępnienia internetowego interfejsu użytkownika, w którym udostępniane są informacje.
Po włączeniu interfejsu ArcGIS Earth Automation API można użyć łącza Swagger dostępnego w sekcji Zaawansowane ustawienia aplikacji. Domyślny adres URL to http://localhost:8000/swagger/index.html.
Interfejs użytkownika Swagger wygląda następująco:
Każdą publiczną metodę działania w kontrolerze można przetestować z poziomu interfejsu użytkownika Swagger.
- Kliknij nazwę metody, aby rozwinąć sekcję.
- Kliknij opcję Wypróbuj.
- Dodaj potrzebne parametry.
- Kliknij opcję Wykonaj.