Implementando Swagger en .Net Core 3.1
Para iniciar la nueva entrada de mi blog, vamos a hablar en esta ocasión de Swagger y Swagger UI.
Si estás incursionando en el mundo del Desarrollo de Apis tendrás muchas dudas sobre estos conceptos, por eso aquí te explicaré un poco sobre ellos, al igual que dejaré un ejemplo sencillo sobre esto.
Mi intención en esta nueva entrada es la de explicarte en pequeños pasos como podemos implementar y usar Swagger en nuestras Web APIs.
¿Qué es Swagger?
En pocas palabras, Swagger es una herramienta que nos permite documentar nuestras Web API, facilitando información de entrada, salida, parámetros, entre otros… Incluso, por medio de Swagger podemos probar nuestra Web API.
Swagger lo podemos implementar en nuestros proyectos .NET CORE de una manera muy fácil.
Paso 1: Creación del proyecto.
En primer lugar, iniciaremos creando nuestro proyecto Web API. En mi caso, estaré utilizando la base que se crea directamente al momento de crear una nueva Web Api en Visual Studio 2019.
Creamos un nuevo proyecto — ASP.Net Core Web Application — y configuramos nuestro proyecto.
Luego de darle nombre a nuestro proyecto, este nos dará a elegir la configuración de este. Luego de esto, le damos en Crear.
Paso 2: Agregando Swagger
Para que podamos utilizar Swagger en nuestra Web Api, será necesario implementar un paquete NuGet llamado Swashbuckle.AspNetCore. Este paquete lo podemos encontrar en NuGet.
Instalaremos el paquete, que a su vez nos pedira que ceptemos la licencia de uso sobre otras dos fuentes.
Con esto, tendremos preparado nuestra Web API para empezar a utilizar Swagger, lo único que nos hace falta ahora, es configurar Swagger en nuestro proyecto.
Paso 3: Configurando Swagger
Dentro del método ConfigureServices que se encuentra en la clase Starup.cs, pegamos las siguientes líneas de código, en las cuales podemos agregar datos como:
- Versión
- Título
- Descripción
- Términos de uso
- Datos de contacto
- Licencia
Todos los datos mencionados anteriormente, son datos opcionales.
También, en el metodo Configure que se encuentra en la misma clase implementaremos el siguiente código, el cual nos permitirá generar la UI que nos ayudará a visualizar de manera más interactiva y amigable los datos.
Paso 4: Accediendo a nuestra Web API
Luego de realizar toda la configuración anterior, ya tendremos listo nuestro proyecto y podremos acceder a la documentación que se va a generar usando la URL que se genera al momento de probar nuestra Web API localmente.
A continuación, listo algunas de las paginas que me sirvieron de inspiración para la realización de esta entrada.
