Deprecazione del metodo di estensione WithOpenApi

I metodi WithOpenApi sono stati deprecati in .NET 10. La chiamata di questi metodi genera ora la diagnostica in fase di compilazione e un avviso standard che indica:

WithOpenApi è deprecato e verrà rimosso in una versione futura. Per altre informazioni, vedere .

Versione introdotta

.NET 10 Preview 7

Comportamento precedente

In precedenza, è possibile usare il metodo di estensione senza avvisi:

app.MapGet("/weather", () => ...)
   .WithOpenApi();   // No warnings.

Nuovo comportamento

A partire da .NET 10, l'uso del metodo di estensione WithOpenApi genera un avviso del compilatore:

app.MapGet("/weather", () => ...)
   .WithOpenApi();   // Warning ASPDEPR002: WithOpenApi is deprecated...

Tuttavia, la chiamata viene comunque compilata ed eseguita.

Tipo di cambiamento che interrompe la compatibilità

Questa modifica può influire sulla compatibilità dell'origine.

Motivo della modifica

funzionalità duplicate ora fornite dalla pipeline di generazione di documenti OpenAPI integrata. Deprecando si semplifica la superficie dell'API e si prepara per la sua eventuale rimozione.

Azione consigliata

Rimuovere le chiamate dal codice.

• Se è stato usato per la generazione di documenti, usare il metodo di estensione.

  Before:

  using Microsoft.AspNetCore.OpenApi;
  
  var builder = WebApplication.CreateBuilder();
  var app = builder.Build();
  
  app.MapGet("/weather", () => ...)
     .WithOpenApi(operation =>
     {
         // Per-endpoint tweaks
         operation.Summary     = "Gets the current weather report.";
         operation.Description = "Returns a short description and emoji.";
         return operation;
     });
  
  app.Run();
  

  After:

  using Microsoft.AspNetCore.OpenApi;
  
  var builder = WebApplication.CreateBuilder();
  var app = builder.Build();
  
  app.MapGet("/weather", () => ...)
     .AddOpenApiOperationTransformer((operation, context, ct) =>
     {
         // Per-endpoint tweaks
         operation.Summary     = "Gets the current weather report.";
         operation.Description = "Returns a short description and emoji.";
         return Task.CompletedTask;
     });
  
  app.Run();
  

• Se è stata usata per la generazione di documenti, usare l'API .

• Se è stata usata per la generazione di documenti, usare l'API .

Le API interessate

• Microsoft.AspNetCore.Builder.OpenApiEndpointConventionBuilderExtensions.WithOpenApi