Balíček Microsoft.Extensions.ApiDescription.Client je zastaralý

Balíček NuGet Microsoft.Extensions.ApiDescription.Client je zastaralý. Balíček zadal cíle MSBuild a podporu rozhraní příkazového řádku, které během sestavení vygenerovaly kód klienta založený na OpenAPI. Projekty, které odkazují na balíček, nyní obdrží upozornění během sestavení.

Verze byla představena

.NET 10 Preview 7

Předchozí chování

Projekty můžou přidávat <PackageReference Include="Microsoft.Extensions.ApiDescription.Client" ... /> položky ( <OpenApiReference> nebo spouštět dotnet openapi) pro generování klientů silného typu v době sestavení.

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

Nové chování

Balíček je teď zastaralý a projekty, které na něj odkazují, obdrží upozornění na sestavení. Cíle MSBuild a příkazy rozhraní příkazového řádku se už nepodporují.

Typ zásadní změny

Tato změna může ovlivnit kompatibilitu zdroje.

Důvod změny

• Balíček od svého zavedení zaznamenal minimální aktualizace a údržbu.
• Jeho abstrakce byly úzce svázány s určitými generátory a nebyly dobře škálovány pro ostatní. Každý generátor teď dodává vlastní prostředí rozhraní příkazového řádku nebo konfigurace, což zprostředkuje střední vrstvu MSBuild.
• Odebrání balíčku snižuje zatížení údržby a objasňuje doporučený pracovní postup pro generování klientů.

Doporučená akce

• Odeberte všechny <PackageReference Include="Microsoft.Extensions.ApiDescription.Client" … /> z projektu.
• Položky nebo dotnet openapi příkazy nahraďte <OpenApiReference> nástroji specifickými pro generátor:
  • NSwag – použijte npx nswag nebo dotnet tool run nswag s konfiguračním souborem .nswag .
  • Kiota – Nainstalujte a dotnet tool install -g Microsoft.OpenApi.Kiota spusťte kiota generate.
  • Generátor OpenAPI – Vyvolání openapi-generator-cli prostřednictvím JAR nebo Dockeru
• Potvrďte vygenerovaný kód klienta nebo spusťte generování ve vlastním kroku před sestavením, který nespoléhá na odebraný balíček.

Ovlivněná rozhraní API

• Položka OpenApiReference NÁSTROJE MSBuild (všechny instance).
• VLASTNOST OpenApiProjectReferenceMSBuild .
• Příkaz dotnet openapirozhraní příkazového řádku .