Documentando API con Swagger

Clase 15 de 22 • Curso de APIs con .NET

Clase anteriorSiguiente clase

José Ángel Soriano Soriano

student•

creo que se quedaron corttos en este capitulo

Miguel Teheran

teacher•

La idea es que los videos y cursos en general queden cortos. Vamos a tener seguranmente un curso avanzado de APIs donde mostraremos mucho mas de Swagger

Joel Angel David Barrantes Palacios

student•

Realmente espero ese curso avanzado con muchas ansias ahora mas que nunca

Carlos Alberto

student•

Muy buena clase... si esta algo básica porque ya esta incluido swagger en el proyecto pero para configurarlo desde cero se pueden guiar con esta url:

Jimmy Buriticá Londoño

student•

Swagger nos facilita la vida.

Platzi Team

student•

Swagger en nuestra API

Documentacion Oficial:

Get started with Swashbuckle and ASP.NET Core

Swagger es una herramienta de documentación de API muy popular que se utiliza para describir, producir y visualizar documentación de API. En .NET, se puede integrar Swagger fácilmente en una aplicación Web API mediante la adición de un paquete NuGet llamado Swashbuckle.

Después de habilitar Swagger en la aplicación, puede acceder a la documentación de la API en la dirección /swagger. La documentación incluye información sobre los endpoints de la API, los verbos HTTP permitidos, los parámetros de entrada y las respuestas.

Además, Swagger también proporciona una interfaz de usuario para probar la API, lo que puede ser muy útil durante el desarrollo y la depuración.

Yan Harold Muñoz Dominguez

student•

Para quienes tenemos una versión actual de .NET y no tienes Swagger instalado por defecto en el proyecto.

Agregar lo siguiente en el archivo .csproj

Luego en el archivo Program.cs

Y listo!

Rene Benjamin Curin Zarate

student•

Muchas gracias, me sirvio

Juan Pablo Urra Jara

student•

Si utilizan .Net 9 tienen que agregar Swagger

1) Instalar dotnet add package Swashbuckle.AspNetCore

2) Modificar el archivo Program.cs para agregar los servicios de Swagger y el middleware:

// Configuración de Swagger
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(); // <-- Agrega Swagger

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.MapOpenApi();
    app.UseSwagger();
    app.UseSwaggerUI(); // Interfaz web de Swagger
}

app.UseHttpsRedirection();

app.UseAuthorization();

//app.UseWelcomePage();

//app.UseTimeMiddleware(); // se agrega el middleware al pipeline de la aplicacion

app.MapControllers();

app.Run();

Luis Eduardo

student•

Yo ya he usado swagger con nestjs y la verdad te facilita mucho la vida al escribir la documentacion

Cristhian Llanos

student•

En que momento crearon la clase HelloWorldController.cs? Ya me he perdido... :(

Miguel Teheran

teacher•

Hola Cristhian revisa la clase 13, ahí se creo ese controlador

Francisco Javier Pineda Giraldo

student•

NO he podido identificar mi error, y no me genera la documentación.

ya limpie los métodos, ayuda por favor?

Miguel Teheran

teacher•

El metodo delete esta ambiguo, le estas poniendo un nombre en la linea 55 [HttpDelete(Name = "GetWeatherForecast")], luego en el route le agregas otro y luego tienes otro HttpDelete al final en la linea 57. debes simplificar esa parte y dejar solo uno

Juan Betancur

student•

Amo este curso, ya lo he visto como 5 o 6 veces y todo el tiempo aprendo cosas nuevas.

Emanuel Alejandro López

student•

MODO RODMY ACTIVADO

Steven Rivas

student•

Swagger fue un extra para una entrevista técnica que tuve hace 4 años.

Eduardo Lemus Zavala

student•

Si no tengo swagger en mi código, que librería puedo descargar? ya descargue una del mismo nombre pero aun así no me funciona

Miguel Teheran

teacher•

Este articulo depronto te puede servir https://mteheran.dev/implementando-swagger-en-web-apis-con-net-core/

Juan Pablo Arano

student•

Cuando intento usar mi url de localhost me dice que la coneccion no es privada, por lo que no me aparece la pagina de swagger :/

"La conexión no es privada Es posible que los atacantes estén intentando robar tu información de localhost (por ejemplo, contraseñas, mensajes o tarjetas de crédito). Más información"

Como soluciono esto?

Miguel Teheran

teacher•

trata de usar la URL que no es https por que depronto tienes problemas con los certificados

LUIS GUILLERMO MONCADA RUIZ

student•

Me sentir con platzi, es que todos los cursos son un abrebocas, pero te toca ir a la documentación oficial a aprender de verdad

Jhon Alexander Perez Beltran

student•

en este caso como se haria la integración de servidores al swagger que no es un controlador

Samil Sanchez

student•

Super la documentación de swagger y emocionado por al próxima clase.

// Configuración de Swagger
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen(); // <-- Agrega Swagger

var app = builder.Build();

// Configure the HTTP request pipeline.
if (app.Environment.IsDevelopment())
{
    app.MapOpenApi();
    app.UseSwagger();
    app.UseSwaggerUI(); // Interfaz web de Swagger
}

app.UseHttpsRedirection();

app.UseAuthorization();

//app.UseWelcomePage();

//app.UseTimeMiddleware(); // se agrega el middleware al pipeline de la aplicacion

app.MapControllers();

app.Run();

Documentando API con Swagger

Introducción a API en .NET

Domina las API con .NET

Prerrequisitos

¿Qué es una API?

¿Qué es REST?

Creando tu primera API con .NET

Funcionamiento de una API en .NET

Consumiendo API desde Postman

Análisis del template para APIs de .NET

Atributos para verbos HTTP

Manejo de rutas

Minimal API vs. Web API

Arquitectura y configuración

¿Qué son los middlewares?

Creando un nuevo middleware

Inyección de dependencias

Agregando Logging a API

Documentando API con Swagger

Manipulación de datos con Entity Framework

Agregando librerías para Entity Framework

Configuración de Entity framework y clases base

Creación de servicios

Inyectando servicios como dependencia

Creando controladores

Probando API con una base de datos SQL server

Outro

Retrospectiva: APIs con .NET