Automation API with Swagger

Swagger, also known as OpenAPI, is a language-agnostic specification for describing REST APIs. It helps developers to understand the capabilities of a service by generating interactive documentation and help pages for web API.

ArcGIS Earth Automation APIpage

ArcGIS Earth Automation API uses Swashbuckle.AspNetCore, an open source project, to generate Swagger documents and implement Swagger UI to offer a web-based UI that provides information.

Once ArcGIS Earth Automation API is enabled, you can find the Swagger link in the Advanced application settings. The default URL is http://localhost:8000/swagger/index.html.

Swagger UI looks like this:

Swagger UI

You can test each public action method in the controller from Swagger UI.

  1. Click a method name to expand the section.
  2. Click Try it out.
  3. Add any necessary parameters.
  4. Click Execute.