Microsoft.Extensions.ApiDescription.Client-Paket veraltet

Das Microsoft.Extensions.ApiDescription.Client NuGet-Paket ist veraltet. Das paket bereitgestellte MSBuild-Ziele und CLI-Unterstützung, die openAPI-basierten Clientcode während des Builds generiert hat. Projekte, die auf das Paket verweisen, erhalten jetzt eine Warnung während des Builds.

Eingeführte Version

.NET 10 Preview 7

Vorheriges Verhalten

Projekte könnten zur Erstellungszeit <PackageReference Include="Microsoft.Extensions.ApiDescription.Client" ... />- und <OpenApiReference>-Elemente hinzufügen oder dotnet openapi ausführen, um stark typisierte Clients zu generieren.

<Project Sdk="Microsoft.NET.Sdk">
  <PropertyGroup>
    <TargetFramework>net10.0</TargetFramework>
  </PropertyGroup>

  <ItemGroup>
    <PackageReference Include="Microsoft.Extensions.ApiDescription.Client" Version="8.0.0" />
  </ItemGroup>

  <ItemGroup>
    <OpenApiReference Include="swagger.json" />
  </ItemGroup>
</Project>

Neues Verhalten

Das Paket ist jetzt veraltet und Projekte, die darauf verweisen, erhalten Buildwarnungen. Die MSBuild-Ziele und CLI-Befehle werden nicht mehr unterstützt.

Art der einschneidenden Änderung

Diese Änderung kann sich auf die Quellkompatibilität auswirken.

Grund für Änderung

• Das Paket hat seit der Einführung minimale Updates und Wartungen gesehen.
• Ihre Abstraktionen waren eng mit bestimmten Generatoren gekoppelt und ließen sich schlecht auf andere übertragen. Jeder Generator liefert nun eine eigene CLI/Konfigurationsoberfläche, wodurch die MSBuild-Middle-Layer redundant wird.
• Durch das Entfernen des Pakets wird der Wartungsaufwand reduziert und der empfohlene Workflow für die Clientgenerierung klargestellt.

Empfohlene Aktion

• Entfernen Sie beliebige <PackageReference Include="Microsoft.Extensions.ApiDescription.Client" … /> Elemente aus Ihrem Projekt.
• Ersetzen Sie <OpenApiReference> Elemente oder dotnet openapi Befehle durch generatorspezifische Tools:
  • NSwag – Verwenden Sie npx nswag oder dotnet tool run nswag mit einer .nswag-Konfigurationsdatei.
  • Kiota – Installieren mit dotnet tool install -g Microsoft.OpenApi.Kiota und ausführen kiota generate.
  • OpenAPI-Generator – Aufrufen openapi-generator-cli über JAR oder Docker.
• Übernehmen Sie den generierten Clientcode, oder führen Sie die Generierung in einem benutzerdefinierten Vorabbuildschritt aus, der nicht auf das entfernte Paket angewiesen ist.

Betroffene APIs

• MSBuild-Element OpenApiReference (alle Instanzen).
• MSBuild-Eigenschaft OpenApiProjectReference.
• CLI-Befehl dotnet openapi.