Migrar da API Web do ASP.NET para o ASP.NET Core

O ASP.NET Core combina os modelos de aplicativo de API Web e MVC do ASP.NET 4.x em um único modelo de programação conhecido como ASP.NET Core MVC.

Esse artigo mostra como você pode migrar o controlador de Produtos criado em Introdução ao ASP.NET Web API 2 para o ASP.NET Core.

Pré-requisitos

Visual Studio

• Visual Studio 2022 com a carga de trabalho do ASP.NET e desenvolvimento Web.
• SDK do .NET 6.0

Visual Studio Code

• Visual Studio Code
• C# para Visual Studio Code (versão mais recente)
• SDK do .NET 6.0

As instruções do Visual Studio Code usam a CLI do .NET para funções de desenvolvimento do ASP.NET Core, como criação de projeto. Você pode seguir estas instruções no macOS, no Linux ou no Windows e com qualquer editor de código. Alterações secundárias poderão ser necessárias se você usar algo diferente do Visual Studio Code.

Crie um projeto de API Web do ASP.NET Core

Visual Studio

1. No menu Arquivo, selecione Novo>Projeto.
2. Insira API Web na caixa de pesquisa.
3. Selecione o modelo API Web do ASP.NET Core e Avançar.
4. Na caixa de diálogo Configurar seu novo projeto, nomeie o projeto como ProductsCore e selecione Avançar.
5. Na caixa de diálogo Informações adicionais:
   1. Confirme se o Framework é o .NET 6.0 (suporte de longo prazo).
   2. Confirme se a caixa de seleção para Usar controladores (desmarcar para usar APIs mínimas) está marcada.
   3. Desmarque Habilitar suporte a OpenAPI.
   4. Selecione Criar.

Visual Studio Code

1. Abra o terminal integrado.

2. Altere os diretórios (cd) para a pasta que conterá a pasta do projeto.

3. Execute os comandos a seguir para criar um novo projeto de API da Web e abri-lo no Visual Studio Code:

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

Remova os arquivos de modelo WeatherForecast

1. Remova os arquivos do exemplo WeatherForecast.cs e Controllers/WeatherForecastController.cs do novo projeto ProductsCore.
2. Abra Properties\launchSettings.json.
3. Altere as propriedades launchUrl de weatherforcast para productscore.

A configuração da API Web do ASP.NET Core

O ASP.NET Core não usa a pasta App_Start nem o arquivo Global.asax. O arquivo web.config é adicionado no momento da publicação. Para obter mais informações, consulte web.config file.

O arquivo Program.cs:

• Substitui o arquivo Global.asax.
• Trata de todas as tarefas de inicialização do aplicativo.

Saiba mais em Inicialização de aplicativos no ASP.NET Core.

A seguir, você verá o código de inicialização do aplicativo no arquivo 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();

Copie o modelo Produto

Visual Studio

1. No Gerenciador de Soluções, clique com o botão direito do mouse no nome do projeto. Selecione Adicionar>Nova Pasta. Nomeie a pasta Models.
2. Clique com o botão direito do mouse na pasta Modelos. Selecione Adicionar>Classe. Nomeie a classe Produto e selecione Adicionar.
3. Substitua o código do modelo de template pelo seguinte:

Visual Studio Code

1. Adicione uma pasta denominada Modelos.
2. Adicione uma classe Produto à pasta Modelos com o seguinte 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; }
    }
}

O código destacado anterior é alterado para o seguinte:

• A anotação ? foi adicionada para declarar as propriedades Name e Category como tipos de referência anuláveis.

Ao utilizar o recurso Anulável introduzido no C# 8, o ASP.NET Core pode fornecer uma análise de fluxo de código adicional e segurança de tempo de compilação no tratamento de tipos de referência. Por exemplo, a proteção contra exceções de referência null.

Nesse caso, a intenção é que Name e Category possam ser tipos anuláveis.

Os projetos do ASP.NET Core 6.0 permitem tipos de referência anuláveis por padrão. Para obter mais informações, confira Tipos de referência anuláveis.

Copie o ProductsController

Visual Studio

1. Clique com o botão direito do mouse na pasta Controllers.
2. Selecione Adicionar > Controlador....
3. Na caixa de diálogo Adicionar Novo Item com Scaffold, selecione Controlador Mvc - Vazio e, em seguida, Adicionar.
4. Nomeie o controlador como ProductsController e selecione Adicionar.
5. Substitua o código do controlador do modelo pelo seguinte:

Visual Studio Code

1. Adicione uma classe ProductsController à pasta Controladores com o seguinte 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;
    }
}

O código destacado anterior altera o seguinte, para que você migre para o ASP.NET Core:

• Remove as instruções de uso dos seguintes componentes do ASP.NET 4.x que não existem no ASP.NET Core:

  • Classe ApiController
  • Namespace System.Web.Http
  • Interface IHttpActionResult

• Altera a instrução using ProductsApp.Models; para using ProductsCore.Models;.

• Define o namespace raiz como ProductsCore.

• Altera ApiController para ControllerBase.

• Adiciona using Microsoft.AspNetCore.Mvc; para resolver a referência ControllerBase.

• Altera o tipo de retorno da ação GetProduct de IHttpActionResult para ActionResult<Product>. Para obter mais informações, consulte Tipos de retorno da ação do controlador.

• Simplifica a instrução return da ação GetProduct para a seguinte instrução:

  return product;
  

• Adiciona os seguintes atributos, que serão explicados nas próximas seções:

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

Roteamento

O ASP.NET Core fornece um modelo de hospedagem mínimo no qual o middleware de roteamento de pontos de extremidade encapsula todo o pipeline de middleware, portanto, as rotas podem ser adicionadas diretamente ao WebApplication sem uma chamada explícita para UseEndpoints ou UseRouting para registrar rotas.

UseRouting ainda pode ser usado para especificar em que local ocorre a correspondência de rotas, mas UseRouting não precisa ser chamado explicitamente se as rotas devem ser correspondidas no início do pipeline do 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();

Observação: As rotas adicionadas diretamente ao WebApplication são executadas no fim do pipeline.

Roteamento no ProductsController migrado

O ProductsController migrado contém os seguintes atributos destacados:

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;
    }
}

• O atributo [Route]configura o padrão de roteamento de atributos do controlador.

• O atributo [ApiController] torna o roteamento de atributos um requisito para todas as ações nesse controlador.

• O roteamento de atributos suporta tokens, como [controller] e [action]. No runtime, cada token é substituído pelo nome do controlador ou da ação, respectivamente, para o qual o atributo foi aplicado. Os tokens:

  • Reduzem ou eliminam a necessidade de você usar cadeias de caracteres codificadas para a rota.
  • Certifique-se de que as rotas permaneçam sincronizadas com os controladores e ações correspondentes quando as refatorações de renomeação automática forem aplicadas.

• As solicitações HTTP Get são habilitadas para ações ProductController com os seguintes atributos:

  • [HttpGet] atributo aplicado à ação GetAllProducts.
  • [HttpGet("{id}")] atributo aplicado à ação GetProduct.

Execute o projeto migrado e navegue até /api/products. Por exemplo: https://localhost:<port>/api/produtos. Você verá uma lista completa de três produtos. Navegue até /api/products/1. O primeiro produto aparece.

Exibir ou baixar código de exemplo (como baixar)

Recursos adicionais

• Criar APIs Web com o ASP.NET Core
• Tipos de retorno de ação do controlador na API Web do ASP.NET Core
• Versão de compatibilidade do ASP.NET Core MVC