Tokiota Blog

Qué es Swagger y cómo añadirlo a tu Api de NetCore


¿Qué es swagger?

Swagger es una serie de reglas, especificaciones y herramientas que nos ayudan a documentar nuestras APIs. En otras palabras, al instalarlo, y ejecutar la API se nos generará una interfaz de usuario que nos permite navegar sobre los diferentes endpoints que tenga nuestra API de manera fácil e intuitiva. Es una herramienta muy útil a la hora de testear nuestras aplicaciones.

¿Cómo lo usamos?

Para utilizar swagger lo primero que debemos hacer es instalarlo, obviamente.

Vamos al gestor de Nuget de nuestra API (Manage Nuget Packages) y buscamos el nuget Swashbuckle.AspNetCore:

Lo siguiente que debemos hacer es registrar el servicio de swagger en nuestra ServiceCollection (clase Startup.cs, método ConfigureServices) añadiendo éstas líneas.

También tendremos que añadir una breve configuración (clase Startup, método Configure) para indicar la ruta donde se ejecutará el swagger, así como también un nombre para la documentación que se nos va a generar.

En mi caso quiero que se ejecute en el directorio raíz de la aplicación y por lo tanto configuraré la propiedad RoutePrefix como cadena vacía.

Llegados a este punto ya podemos ejecutar nuestra API y comprobar lo de lo que es capaz nuestro asistente para documentación y testing.

En las siguientes imágenes podemos ver un ejemplo paso a paso:

  • Vista preliminar:
  • Método Get Simple:
  • Método Post con asistente de creación del objeto:

Fácil y sencillo.
Hasta la próxima.


Escrito por:

Francisco Javier Lafuente Francisco Javier Lafuente
Development & Cloud Consultant

Comparte esto: