API de automatización con Swagger

Swagger, también conocido como OpenAPI, es una especificación independiente del lenguaje para describir las API REST. Ayuda a los desarrolladores a comprender las capacidades de un servicio mediante la generación de documentación interactiva y páginas de ayuda para la API web.

Página de ArcGIS Earth Automation API

ArcGIS Earth Automation API utiliza Swashbuckle.AspNetCore, un proyecto de código abierto, para generar documentos Swagger e implementar la UI de Swagger para ofrecer una interfaz de usuario basada en la web que proporcione información.

Una vez habilitado ArcGIS Earth Automation API, puede encontrar el enlace Swagger en la configuración avanzada de la aplicación. La dirección URL predeterminada es http://localhost:8000/swagger/index.html.

La UI de Swagger tiene el siguiente aspecto:

UI de Swagger

Puede probar cada método de acción pública en el controlador desde la UI de Swagger.

  1. Haga clic en el nombre de un método para ampliar la sección.
  2. Haga clic en Pruébelo.
  3. Agregue los parámetros necesarios.
  4. Haga clic en Ejecutar.