Skip to content

Add instructions for viewing build-time OpenAPI logs #36071

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

Add instructions for viewing build-time OpenAPI logs #36071

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
5018d74
Docs: Add instructions for viewing build-time OpenAPI logs with Termi…
mohaimenpxl Sep 8, 2025
3b56ed3
Updates
guardrex Sep 8, 2025
be1b134
Updates
guardrex Sep 8, 2025
2fcd3b8
Updates
guardrex Sep 9, 2025
9df3c47
Updates
guardrex Sep 9, 2025
5ef65d8
Updates
guardrex Sep 9, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 17 additions & 1 deletion aspnetcore/fundamentals/openapi/aspnetcore-openapi.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ description: Learn how to generate and customize OpenAPI documents in an ASP.NET
ms.author: safia
monikerRange: '>= aspnetcore-6.0'
ms.custom: mvc
ms.date: 07/09/2025
ms.date: 09/08/2025
uid: fundamentals/openapi/aspnetcore-openapi
---
# Generate OpenAPI documents
Expand Down Expand Up @@ -193,6 +193,22 @@ In some scenarios, it's helpful to generate the OpenAPI document during the app'

To add support for generating OpenAPI documents at build time, install the `Microsoft.Extensions.ApiDescription.Server` package:

## View build-time OpenAPI logs (Terminal Logger)

When `Microsoft.Extensions.ApiDescription.Server` runs the **:::no-loc text="GetDocument":::** step during `dotnet build`, progress messages may not appear with the .NET Terminal Logger at default verbosity in .NET 8 or later. To surface these messages while building, use ***either*** of the following options with the `dotnet build` command.

Detailed Terminal Logger verbosity with the `-tlp` option set with `v=d` (verbosity = detailed):

```dotnetcli
dotnet build -tlp:v=d
```

Disable the Terminal Logger and use legacy-style logs with the [`--tl` option](/dotnet/core/tools/dotnet-build#options) set to `off`:

```dotnetcli
dotnet build --tl:off
```

### [Visual Studio](#tab/visual-studio)

Run the following command from the **Package Manager Console**:
Expand Down