Uso de Swashbuckle para crear un documento de OpenAPI
Para poder publicar una API web en Azure API Management con Visual Studio, debe tener un documento de descripción de OpenAPI.
API Management usa este documento para detectar los puntos de conexión de la API web.
Y, con el uso de las herramientas de Swashbuckle, los desarrolladores de VanArsdel tienen más fácil que nunca crear una descripción de OpenAPI de sus API web.
¿Qué es OpenAPI y para qué sirve?
El documento de OpenAPI define una descripción de interfaz estándar de las API web independiente del lenguaje de programación. Permite a los usuarios y equipos informáticos detectar y comprender las funcionalidades de un servicio sin tener acceso al código fuente, a documentación adicional o a la inspección del tráfico de red.
El documento de OpenAPI es un contrato para las API web. Y es todo lo que necesita una aplicación de consumo para comprender las API web y comunicarse con ellas, sin tener que saber dónde se encuentran las API o si se están ejecutando.
Generación de un documento de OpenAPI desde una aplicación de API web de ASP.NET Core
Hay varias maneras de generar el documento de OpenAPI desde la API web de ASP.NET Core. Swashbuckle es la manera más conocida de hacerlo.
Es fácil de usar y, una vez instalado en la aplicación, muestra automáticamente la pantalla de interfaz de usuario de Swagger.
Swashbuckle también genera el documento de OpenAPI sobre la marcha, que incluye todos los detalles del punto de conexión de API, las estructuras de la carga, los requisitos de seguridad, etc. Este es el documento de ejemplo de la API web de VanArsdel para la administración del inventario.
En la siguiente unidad, un ejercicio le mostrará cómo habilitar esta funcionalidad de OpenAPI en la aplicación de API web de ASP.NET Core.