Introducción
En este capítulo crearemos nuestro primer proyecto ASP.NET Core Web API utilizando Visual Studio. Esta API será el backend de la aplicación que desarrollaremos durante el curso y será responsable de exponer los servicios que consumirá nuestra aplicación Angular.
Si vas a trabajar con Visual Studio Code en lugar de Visual Studio, puedes omitir este capítulo y seguir el procedimiento alternativo que se mostrará más adelante.
Crear un nuevo proyecto Web API
Comienza abriendo Visual Studio.
En la pantalla principal selecciona la opción:
Create a new project
Visual Studio mostrará una lista con las plantillas de proyectos disponibles, entre las que se encuentran:
Aplicaciones de consola.
Aplicaciones Blazor.
Aplicaciones .NET Aspire.
Razor Pages.
APIs web.
Entre otras.
Para este curso seleccionaremos la plantilla:
ASP.NET Core Web API
Asegúrate de elegir la opción que utiliza C# como lenguaje de programación.
Luego haz clic en:
Next
Configuración del proyecto
En la siguiente pantalla debemos configurar la información básica del proyecto.
Nombre del proyecto
Utilizaremos el siguiente nombre:
PeliculasAPI
Ubicación
Selecciona la carpeta donde deseas almacenar el proyecto.
Una vez configurados estos valores, haz clic en:
Next
Configuración de ASP.NET Core
En la pantalla de configuración adicional seleccionaremos las siguientes opciones:
Framework
.NET 9
HTTPS
Mantén habilitado HTTPS para trabajar en un entorno seguro durante el desarrollo.
OpenAPI Support
Activa la opción:
Enable OpenAPI support
Controllers
Selecciona la opción:
Use controllers
Finalmente, haz clic en:
Create
Visual Studio generará automáticamente la estructura inicial de nuestro proyecto Web API.
Configurar el archivo launchSettings.json
Antes de comenzar a desarrollar, realizaremos algunas configuraciones adicionales.
En el Explorador de Soluciones navega hasta:
Properties
└── launchSettings.json
Este archivo contiene la configuración utilizada cuando ejecutamos la aplicación.
Habilitar apertura automática del navegador
Ubica la propiedad:
"launchBrowser": false
y cámbiala por:
"launchBrowser": true
De esta forma, al ejecutar el proyecto Visual Studio abrirá automáticamente el navegador.
Es recomendable realizar este cambio tanto en el perfil HTTP como en el perfil HTTPS.
Configurar la URL inicial
Agrega o modifica la propiedad:
"launchUrl": "swagger"
Esta configuración indica que, al iniciar la aplicación, se abrirá directamente la interfaz de Swagger.
¿Qué es Swagger?
Swagger es una herramienta que permite documentar y probar APIs de manera visual.
A través de Swagger podremos:
Visualizar todos los endpoints disponibles.
Consultar los parámetros requeridos.
Ejecutar peticiones HTTP.
Analizar respuestas del servidor.
Probar la API sin utilizar herramientas externas.
A lo largo del curso trabajaremos frecuentemente con esta herramienta.
Instalar Swashbuckle
Para habilitar Swagger en nuestro proyecto utilizaremos una biblioteca llamada Swashbuckle.AspNetCore.
Abrir el administrador de paquetes NuGet
Haz clic derecho sobre el proyecto:
PeliculasAPI
y selecciona:
Manage NuGet Packages...
Después ve a la pestaña:
Browse
y busca:
Swashbuckle.AspNetCore
Selecciona el paquete y haz clic en:
Install
Luego acepta los términos de instalación.
Configurar Swagger en Program.cs
Después de instalar el paquete Swashbuckle.AspNetCore, abre el archivo Program.cs y reemplaza la configuración de OpenAPI por la siguiente:
var builder = WebApplication.CreateBuilder(args);
// Add services to the container.
builder.Services.AddControllers();
// Servicios necesarios para Swagger
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
var app = builder.Build();
// Configuración de Swagger
if (app.Environment.IsDevelopment())
{
app.UseSwagger();
app.UseSwaggerUI();
}
app.UseHttpsRedirection();
app.UseAuthorization();
app.MapControllers();
app.Run();
Explicación
Registrar los servicios de Swagger
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
Estas líneas agregan los servicios necesarios para:
Descubrir los endpoints de la API.
Generar automáticamente la documentación OpenAPI.
Mostrar dicha documentación mediante Swagger UI.
Habilitar Swagger
app.UseSwagger();
Genera el documento JSON con la descripción de la API.
Habilitar Swagger UI
app.UseSwaggerUI();
Activa la interfaz gráfica que permite:
Ver los endpoints disponibles.
Consultar parámetros.
Ejecutar peticiones.
Visualizar respuestas.
Configuración de launchSettings.json
Además, el instructor configura el archivo Properties/launchSettings.json para que el navegador se abra automáticamente en Swagger.
"launchBrowser": true,
"launchUrl": "swagger"
Por ejemplo:
"profiles": {
"https": {
"commandName": "Project",
"launchBrowser": true,
"launchUrl": "swagger",
"applicationUrl": "https://localhost:7001;http://localhost:5001",
"environmentVariables": {
"ASPNETCORE_ENVIRONMENT": "Development"
}
}
}
Resultado
Al ejecutar la aplicación con:
Ctrl + F5
o
Start Without Debugging
se abrirá automáticamente una URL similar a:
https://localhost:7001/swagger
donde podrás visualizar y probar todos los endpoints de tu Web API desde la interfaz de Swagger.
Nota para ASP.NET Core 9
Cuando creas un proyecto nuevo con la plantilla de .NET 9 Web API, es común encontrar inicialmente algo parecido a:
builder.Services.AddOpenApi();
...
if (app.Environment.IsDevelopment())
{
app.MapOpenApi();
}
En este curso, esa configuración se reemplaza por:
builder.Services.AddEndpointsApiExplorer();
builder.Services.AddSwaggerGen();
...
app.UseSwagger();
app.UseSwaggerUI();
porque se utilizará Swagger UI durante todo el desarrollo para probar los endpoints de forma visual.
Ejecutar la aplicación
Para iniciar el proyecto podemos utilizar:
Ctrl + F5
o el botón:
Start Without Debugging
Visual Studio compilará la aplicación y abrirá automáticamente el navegador.
Si la configuración fue correcta, la URL mostrada será similar a:
https://localhost:xxxx/swagger
donde xxxx corresponde al puerto asignado por ASP.NET Core.
Explorar Swagger
Al abrir Swagger veremos una interfaz similar a la siguiente:
PeliculasAPI
└── Endpoints disponibles
De manera predeterminada, ASP.NET Core crea un endpoint de ejemplo que nos permitirá verificar que todo funciona correctamente.
Para probarlo:
Expande el endpoint.
Haz clic en Try it out.
Presiona Execute.
Swagger enviará una petición HTTP al servidor y mostrará:
La URL utilizada.
El código de estado HTTP.
La respuesta recibida.
Esto confirma que nuestra API está funcionando correctamente.
Otras herramientas para probar APIs
Aunque utilizaremos Swagger durante el curso, existen otras alternativas para interactuar con APIs REST.
Entre las más populares se encuentran:
Postman
Herramienta de escritorio especializada en pruebas de APIs.
Permite:
Crear colecciones de peticiones.
Automatizar pruebas.
Organizar endpoints.
Archivos HTTP
Visual Studio y Visual Studio Code permiten crear archivos .http para realizar peticiones HTTP directamente desde el editor.
Ejemplo:
ejemplo.http
Desde estos archivos es posible ejecutar solicitudes sin necesidad de aplicaciones externas.
Enfoque utilizado en este curso
Aunque existen varias formas de probar una API, en este curso utilizaremos principalmente Swagger, ya que:
Está integrado directamente en ASP.NET Core.
No requiere software adicional.
Permite visualizar rápidamente todos los endpoints.
Facilita el aprendizaje y las pruebas durante el desarrollo.
Resumen
En este capítulo creamos nuestro primer proyecto ASP.NET Core Web API utilizando Visual Studio.
Las actividades realizadas fueron:
Crear el proyecto PeliculasAPI.
Configurar .NET 9 y el soporte para controladores.
Modificar el archivo launchSettings.json.
Instalar el paquete Swashbuckle.AspNetCore.
Configurar Swagger en Program.cs.
Ejecutar la aplicación.
Verificar el funcionamiento de la API mediante Swagger.
Con esto ya tenemos preparado el backend que servirá de base para el desarrollo de nuestra aplicación de películas utilizando Angular 19, ASP.NET Core 9 y SQL Server.
No hay comentarios:
Publicar un comentario