Migración de ASP.NET Web API a ASP.NET Core

ASP.NET Core combina los modelos de aplicación MVC y Web API de ASP.NET 4.x en un único modelo de programación conocido como ASP.NET Core MVC.

En este artículo se muestra cómo migrar el controlador Products creado en Introducción con ASP.NET Web API 2 a ASP.NET Core.

Requisitos previos

Visual Studio

• Visual Studio 2022 con la carga de trabajo de ASP.NET y desarrollo web
• SDK de .NET 6.0

Visual Studio Code

• Visual Studio Code
• C# para Visual Studio Code (versión más reciente)
• SDK de .NET 6.0

Las instrucciones de Visual Studio Code usan la CLI de .NET para las funciones de desarrollo de ASP.NET Core, como la creación de los proyectos. Puede seguir dichas instrucciones en macOS, Linux o Windows y con cualquier editor de código. Si usa otra herramienta que no sea Visual Studio Code, es posible que sea necesario realizar cambios menores.

Crear el nuevo proyecto ASP.NET Core Web API

Visual Studio

1. En el menú Archivo, seleccione Nuevo>Proyecto.
2. Escriba API web en el cuadro de búsqueda.
3. Seleccione la plantilla API web de ASP.NET Core y seleccione Siguiente.
4. En el cuadro de diálogo Configure su nuevo proyecto, nombre el proyecto ProductsCore y seleccione Siguiente.
5. En el cuadro de diálogo Información adicional:
   1. Confirme que el Marco es .NET 6.0 (Compatibilidad a largo plazo).
   2. Confirme que la casilla Use controllers(uncheck to use minimal APIs) [Usar controladores (desactivar para usar API mínimas)] está activada.
   3. Desactive Habilitar compatibilidad con OpenAPI.
   4. Seleccione Crear.

Visual Studio Code

1. Abra el terminal integrado.

2. Cambie los directorios (cd) a la carpeta que va a contener la carpeta del proyecto.

3. Ejecute los siguientes comandos para crear un nuevo proyecto API web y ábralo en Visual Studio Code:

   dotnet new webapi -o ProductsCore --no-openapi
   cd ProductsCore
   code -r ../ProductsCore
   

Elimine los archivos de plantilla WeatherForecast.

1. Elimine los archivos de ejemplo WeatherForecast.cs y Controllers/WeatherForecastController.cs del nuevo proyecto ProductsCore.
2. Abra Properties\launchSettings.json.
3. Cambie las propiedades de launchUrlde weatherforcast a productscore.

La Configuración para ASP.NET Core Web API

ASP.NET Core no utiliza la carpeta App_Start ni el archivo Global.asax. El archivo web.config se añade en el momento de la publicación. Para más información, consulte archivo web.config.

El archivo Program.cs:

• Sustituye a Global.asax.
• Maneja todas las tareas de inicio de la aplicación.

Para obtener más información, vea Inicio de la aplicación en ASP.NET Core.

A continuación se muestra el código de inicio de la aplicación en el archivo ASP.NET Core Program.cs:

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();

var app = builder.Build();

// Configure the HTTP request pipeline.

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

Copiar el modelo Producto

Visual Studio

1. En el Explorador de soluciones, haga clic con el botón derecho en el proyecto. Seleccione Agregar>Nueva carpeta. Asigne a la carpeta el nombre Models.
2. Haga clic con el botón derecho en la carpeta Models. Seleccione Agregar>Clase. Nombre la clase Producto y seleccione Añadir.
3. Sustituya el código del modelo de plantilla por lo siguiente:

Visual Studio Code

1. Agregue una carpeta denominada Models.
2. Añada una clase Producto a la carpeta Modelos con el siguiente código:

namespace ProductsCore.Models
{
    public class Product
    {
        public int Id { get; set; }
        public string? Name { get; set; }
        public string? Category { get; set; }
        public decimal Price { get; set; }
    }
}

El código resaltado anterior cambia lo siguiente:

• Se ha añadido la anotación ? para declarar las propiedades Name y Category como tipos de referencia nula.

Al utilizar la función Nullable introducida en C# 8, ASP.NET Core puede proporcionar un análisis de flujo de código adicional y seguridad en tiempo de compilación en el manejo de tipos de referencia. Por ejemplo, protección frente a excepciones de referencia null.

En este caso, la intención es que Name y Category puedan ser tipo que acepta valores NULL.

Los proyectos ASP.NET Core 6.0 permiten tipos de referencia nula de manera predeterminada. Para más información, consulte Tipos de referencia que admiten un valor NULL.

Copie el ProductsController

Visual Studio

1. Haga clic con el botón derecho en la carpeta Controllers.
2. Seleccione Añadir > Controlador....
3. En el cuadro de diálogo Agregar nuevo elemento de andamio, seleccione Controlador Mvc - Vacío y, a continuación, seleccione Agregar.
4. Nombre el controlador ProductsController y seleccione Agregar.
5. Sustituya el código del controlador de plantilla por el siguiente:

Visual Studio Code

1. Añada una clase ProductsController a la carpeta Controllers con el siguiente código:

using Microsoft.AspNetCore.Mvc;
using ProductsCore.Models;

namespace ProductsCore.Controllers;

[Route("api/[controller]")]
[ApiController]
public class ProductsController : ControllerBase
{
    Product[] products = new Product[]
    {
            new Product
            {
                Id = 1, Name = "Tomato Soup", Category = "Groceries", Price = 1
            },
            new Product
            {
                Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M
            },
            new Product
            {
                Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M
            }
    };

    [HttpGet]
    public IEnumerable<Product> GetAllProducts()
    {
        return products;
    }

    [HttpGet("{id}")]
    public ActionResult<Product> GetProduct(int id)
    {
        var product = products.FirstOrDefault((p) => p.Id == id);
        if (product == null)
        {
            return NotFound();
        }
        return product;
    }
}

El código resaltado anterior cambia lo siguiente, para migrar a ASP.NET Core:

• Quita las sentencias con de los siguientes componentes de ASP.NET 4.x que no existen en ASP.NET Core:

  • Clase ApiController
  • Espacio de nombres System.Web.Http
  • IHttpActionResult (interfaz)

• Cambia la sentencia using ProductsApp.Models; por using ProductsCore.Models;.

• Establece el espacio de nombres raíz en ProductsCore.

• Cambia ApiController por ControllerBase.

• Añade using Microsoft.AspNetCore.Mvc; para resolver la referencia ControllerBase.

• Cambia el tipo de retorno de la acción GetProduct de IHttpActionResult a ActionResult<Product>. Para obtener más información, consulte Tipos de valor devuelto de acción del controlador.

• Simplifica la sentencia return de la acción GetProduct a la siguiente sentencia:

  return product;
  

• Añade los siguientes atributos que se explican en las siguientes secciones:

  • [Route("api/[controller]")]
  • [ApiController]
  • [HttpGet]
  • [HttpGet("{id}")]

Enrutamiento

ASP.NET Core proporciona un modelo de alojamiento mínimo en el que el middleware de enrutamiento de punto de conexión envuelve toda la canalización de middleware, por lo tanto, las rutas se pueden agregar directamente a la WebApplication sin una llamada explícita a UseEndpoints o UseRouting para registrar rutas.

UseRouting todavía se puede usar para especificar dónde se produce la coincidencia de rutas, pero UseRouting no es necesario llamar explícitamente si las rutas deben coincidir al principio de la canalización de middleware.

var builder = WebApplication.CreateBuilder(args);

// Add services to the container.

builder.Services.AddControllers();

var app = builder.Build();

// Configure the HTTP request pipeline.

app.UseHttpsRedirection();

app.UseAuthorization();

app.MapControllers();

app.Run();

Nota: Las rutas agregadas directamente a WebApplication se ejecutan al final de la canalización.

Enrutamiento en el ProductsController migrado

El ProductsController migrado contiene los siguientes atributos resaltados:

using Microsoft.AspNetCore.Mvc;
using ProductsCore.Models;

namespace ProductsCore.Controllers;

[Route("api/[controller]")]
[ApiController]
public class ProductsController : ControllerBase
{
    Product[] products = new Product[]
    {
            new Product
            {
                Id = 1, Name = "Tomato Soup", Category = "Groceries", Price = 1
            },
            new Product
            {
                Id = 2, Name = "Yo-yo", Category = "Toys", Price = 3.75M
            },
            new Product
            {
                Id = 3, Name = "Hammer", Category = "Hardware", Price = 16.99M
            }
    };

    [HttpGet]
    public IEnumerable<Product> GetAllProducts()
    {
        return products;
    }

    [HttpGet("{id}")]
    public ActionResult<Product> GetProduct(int id)
    {
        var product = products.FirstOrDefault((p) => p.Id == id);
        if (product == null)
        {
            return NotFound();
        }
        return product;
    }
}

• El atributo [Route]configura el patrón de enrutamiento de atributos del controlador.

• El atributo [ApiController] hace que el enrutamiento de atributos sea un requisito para todas las acciones de este controlador.

• El enrutamiento de atributos admite tokens, como [controller] y [action]. En tiempo de ejecución, cada token se sustituye por el nombre del controlador o acción, respectivamente, al que se ha aplicado el atributo. Los tokens:

  • Reducen o eliminan la necesidad de utilizar cadenas codificadas para la ruta.
  • Garantizan que las rutas permanezcan sincronizadas con los controladores y acciones correspondientes cuando se aplican refactorizaciones automáticas de cambio de nombre.

• Las peticiones HTTP Get están habilitadas para las acciones ProductController con los siguientes atributos:

  • [HttpGet] atributo aplicado a la acción GetAllProducts.
  • [HttpGet("{id}")] atributo aplicado a la acción GetProduct.

Ejecute el proyecto migrado y vaya a /api/products. Por ejemplo: https://localhost:<port>/api/products. Aparece una lista completa de tres productos. Vaya a /api/products/1. Aparece el primer producto.

Vea o descargue el código de ejemplo (cómo descargarlo)

Recursos adicionales

• Creación de API web con ASP.NET Core
• Tipos de valor devuelto de acción del controlador en la API web de ASP.NET Core
• Versión de compatibilidad para ASP.NET Core MVC