Skip to content

Commit cc13edf

Browse files
Copilotwadepickett
andauthored
Add migration note for Swashbuckle CLI to built-in OpenAPI support (#36512)
* Initial plan * Add migration note for Swashbuckle CLI users to built-in OpenAPI support Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com> * Apply suggestion from @wadepickett Added link for package * Apply suggestion from @wadepickett Clarified Interactive UI. * Apply suggestion from @wadepickett * Apply suggestion from @wadepickett * Apply suggestion from @wadepickett Add NuGet link for package * Apply suggestion from @wadepickett --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: wadepickett <10985336+wadepickett@users.noreply.github.com> Co-authored-by: Wade Pickett <wpickett@microsoft.com>
1 parent f6ca809 commit cc13edf

1 file changed

Lines changed: 8 additions & 2 deletions

File tree

aspnetcore/fundamentals/openapi/aspnetcore-openapi.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,12 @@
11
---
22
title: Generate OpenAPI documents
3+
ai-usage: ai-assisted
34
author: captainsafia
45
description: Learn how to generate and customize OpenAPI documents in an ASP.NET Core app.
5-
ms.author: safia
66
monikerRange: '>= aspnetcore-6.0'
7+
ms.author: safia
78
ms.custom: mvc
8-
ms.date: 12/10/2025
9+
ms.date: 12/17/2025
910
uid: fundamentals/openapi/aspnetcore-openapi
1011
---
1112
# Generate OpenAPI documents
@@ -183,6 +184,11 @@ You can customize the <xref:Microsoft.AspNetCore.OpenApi.OpenApiOptions.ShouldIn
183184

184185
## Generate OpenAPI documents at build time
185186

187+
> [!NOTE]
188+
> Starting with .NET 9, ASP.NET Core includes built-in OpenAPI support. The [`Microsoft.AspNetCore.OpenApi`](https://www.nuget.org/packages/Microsoft.AspNetCore.OpenApi) package provides OpenAPI document generation at runtime, and adding the [`Microsoft.Extensions.ApiDescription.Server` ](https://www.nuget.org/packages/Microsoft.Extensions.ApiDescription.Server) package enables build-time document generation.
189+
>
190+
>ASP.NET Core generates OpenAPI documents only. Interactive UIs such as **Swagger UI** or **Scalar** are not included by default and must be added separately. For guidance on using these UI options, see <xref:fundamentals/openapi/using-openapi-documents>.
191+
186192
In typical web apps, OpenAPI documents are generated at runtime and served via an HTTP request to the app server.
187193

188194
In some scenarios, it's helpful to generate the OpenAPI document during the app's build step. These scenarios include generating OpenAPI documentation that is:

0 commit comments

Comments
 (0)