Eseguire la migrazione dall'API Web ASP.NET a ASP.NET Core

ASP.NET Core combina i modelli di app MVC e Web di ASP.NET 4.x in un singolo modello di programmazione noto come ASP.NET Core MVC.

Questo articolo illustra come eseguire la migrazione del controller Products creato in Introduzione all'API Web ASP.NET 2 a ASP.NET Core.

Prerequisites

Visual Studio

• Visual Studio 2022 con il carico di lavoro Sviluppo ASP.NET e Web.
• .NET 6 SDK

Visual Studio Code

• Visual Studio Code
• C# per Visual Studio Code (versione più recente)
• .NET 6 SDK

Le istruzioni di Visual Studio Code usano l'interfaccia della riga di comando di .NET per le funzioni di sviluppo di ASP.NET Core, ad esempio la creazione di progetti. È possibile seguire queste istruzioni in macOS, Linux o Windows e con qualsiasi editor di codice. Se si usa un editor diverso da Visual Studio Code potrebbero essere necessarie alcune modifiche minime.

Creare il nuovo progetto API Web core ASP.NET

Visual Studio

1. Dal menu File, scegliere Nuovo>Progetto.
2. Immettere Web API nella casella di ricerca.
3. Selezionare il modello API Web ASP.NET Core e selezionare Avanti.
4. Nella finestra di dialogo Configura il nuovo progetto assegnare al progetto il nome ProductsCore e selezionare Avanti.
5. Nella finestra di dialogo Informazioni aggiuntive :
   1. Confermare che il Framework è .NET 6.0 (supporto a lungo termine).
   2. Verificare che sia selezionata la casella di controllo Usa controller (deselezionare l'uso delle API minime).
   3. Deseleziona Abilita supporto OpenAPI.
   4. Fare clic su Crea.

Visual Studio Code

1. Aprire il terminale integrato.

2. Cambia directory (cd) alla cartella che conterrà la cartella del progetto.

3. Eseguire i comandi seguenti per creare un nuovo progetto API Web e aprirlo in Visual Studio Code:

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

Rimuovere il file modello Meteo

1. Rimuovere i file di esempio WeatherForecast.cs e Controllers/WeatherForecastController.cs dal nuovo progetto ProductsCore.
2. Aprire Proprietà\launchSettings.jsattiva.
3. Modificare le proprietà di launchUrl da weatherforcast a productscore.

Configurazione per l'API Web core di ASP.NET

ASP.NET Core non usa la cartella App_Start o il file Global.asax. Il file web.config viene aggiunto in fase di pubblicazione. Per altre informazioni, vedere web.config file.

File Program.cs:

• Sostituisce Global.asax.
• Gestisce tutte le attività di avvio dell'app.

Per altre informazioni, vedere Avvio dell'app in ASP.NET Core.

Di seguito viene illustrato il codice di avvio dell'applicazione nel file 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();

Copiare il modello prodotto

Visual Studio

1. In Esplora soluzioni fare clic con il pulsante destro del mouse sul progetto. Selezionare Aggiungi>Nuova cartella. Denominare la cartella Models.
2. Fare clic con il pulsante destro del mouse sulla cartella Modelli. Selezionare Aggiungi classe>. Denominare la classe Product e selezionare Aggiungi.
3. Sostituire il codice del modello di template con il codice seguente:

Visual Studio Code

1. Aggiungere una cartella denominata Models.
2. Aggiungere una classe Product alla cartella Modelli di con il codice seguente:

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

Il codice evidenziato precedente modifica quanto segue:

• L'annotazione ? è stata aggiunta per dichiarare le proprietà Name e Category come tipi riferimento nullable.

Usando la funzionalità Nullable introdotta in C# 8, ASP.NET Core può fornire un'ulteriore analisi del flusso di codice e la sicurezza in fase di compilazione nella gestione dei tipi di riferimento. Ad esempio, proteggere da eccezioni di riferimento null.

In questo caso, l'intento è che Name e Category possano essere tipi nullable.

ASP.NET Core nei progetti .NET 6 abilita i tipi di riferimento annullabili di default. Per ulteriori informazioni, vedere tipi di riferimento annullabile.

Copiare il ProductsController

Visual Studio

1. Fare clic con il pulsante destro del mouse sulla cartella Controller.
2. Seleziona Aggiungi > Controller....
3. In finestra di dialogo Aggiungi nuovo elemento con scaffolding selezionare controller Mvc - Vuoto quindi selezionare Aggiungi.
4. Denominare il controller ProductsController e selezionare Aggiungi.
5. Sostituire il codice del controller modello con quanto segue:

Visual Studio Code

1. Aggiungere una classe ProductsController alla cartella Controllers con il codice seguente:

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

Il codice evidenziato precedente modifica quanto segue per eseguire la migrazione a ASP.NET Core:

• Rimuove le istruzioni using per i componenti di ASP.NET 4.x seguenti che non esistono in ASP.NET Core.

  • Classe ApiController
  • spazio dei nomi System.Web.Http
  • interfaccia IHttpActionResult

• Modifica l'istruzione using ProductsApp.Models; in using ProductsCore.Models;.

• Imposta lo spazio dei nomi radice su ProductsCore.

• Modifica ApiController in ControllerBase.

• Aggiunge using Microsoft.AspNetCore.Mvc; per risolvere il riferimento ControllerBase.

• Modifica il tipo restituito dell'azione di GetProduct da IHttpActionResult a ActionResult<Product>. Per altre informazioni, vedere Controller action return types.

• Semplifica l'istruzione GetProduct dell'azione return con l'istruzione seguente:

  return product;
  

• Aggiunge gli attributi seguenti illustrati nelle sezioni successive:

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

Routing

ASP.NET Core fornisce un modello di hosting minimo in cui il middleware di routing degli endpoint esegue il wrapping dell'intera pipeline middleware, pertanto è possibile aggiungere route direttamente all'WebApplication senza una chiamata esplicita a UseEndpoints o UseRouting per registrare le route.

UseRouting può comunque essere usato per specificare dove si verifica la corrispondenza delle route, ma UseRouting non deve essere chiamato in modo esplicito se le route devono essere confrontate all'inizio della pipeline 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: Route aggiunte direttamente al WebApplication eseguito alla fine della pipeline.

Routing nel ProductsController migrato

Il ProductsController migrato contiene gli attributi evidenziati seguenti:

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

• L'attributo [Route]configura il modello di routing degli attributi del controller.

• L'attributo [ApiController] rende il routing degli attributi un requisito per tutte le azioni in questo controller.

• Routing degli attributi supporta i token, ad esempio [controller] e [action]. In fase di esecuzione, ogni token viene sostituito rispettivamente con il nome del controller o dell'azione a cui è stato applicato l'attributo. I token:

  • Ridurre o eliminare la necessità di usare stringhe codificate manualmente per il percorso.
  • Assicurarsi che le route rimangano sincronizzate con i controller e le azioni corrispondenti quando vengono applicate ridenominazioni automatiche.

• Le richieste HTTP Get sono abilitate per le azioni ProductController con gli attributi seguenti:

  • Attributo [HttpGet] applicato all'azione GetAllProducts.
  • Attributo [HttpGet("{id}")] applicato all'azione GetProduct.

Eseguire il progetto migrato e passare a /api/products. Ad esempio: https://localhost:<port>/api/products. Viene visualizzato un elenco completo di tre prodotti. Naviga verso /api/products/1. Viene visualizzato il primo prodotto.

Visualizzare o scaricare il codice di esempio (come scaricare)

Risorse aggiuntive

• Creare API Web con ASP.NET Core
• Tipi restituiti dall'azione del controller nell'API Web ASP.NET Core
• versione di compatibilità per ASP.NET Core MVC