Getting Started with NSwag and Swashbuckle: Note and link to new OpenAPI overview

[wadepickett]

Description

https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-nswag

In PR #33431 these topics were locked down to version 8 and will not be moved up to newer versions.
aspnetcore/tutorials/getting-started-with-NSwag.md
aspnetcore/tutorials/getting-started-with-swashbuckle.md
aspnetcore/tutorials/web-api-help-pages-using-swagger.md

However, the traffic going to these topics are significant. It is also a high priority item on the freshness to do list as a result with getting-started-with-NSwag.md being the highest on that list.

I think a note should be added at the very top indicating the new OpenAPI supoprt available starting with .NET 9 and link to the overview (and starting point) for the new OpenAPI topics here: https://learn.microsoft.com/aspnet/core/fundamentals/openapi/overview.

Page URL

https://learn.microsoft.com/en-us/aspnet/core/tutorials/getting-started-with-nswag?view=aspnetcore-8.0&tabs=visual-studio

Content source URL

https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/tutorials/getting-started-with-NSwag.md

Document ID

25f7fb5b-92b0-a45b-57ab-fdceab571884

Article author

@zuckerthoben

Metadata

• ID: 2483813a-3c16-7ddd-3160-43e6843b55d4
• Service: aspnet-core
• Sub-service: tutorials

Related Issues

[wadepickett]

@tdykstra, what do you think of my suggestion here? I ask since you put in the original fix for .NET 9 here and figured you might have some thoughts on it: https://github.com/dotnet/AspNetCore.Docs/pull/33431/files.

[tdykstra]

I think a note should be added at the very top indicating the new OpenAPI support available starting with .NET 9 and link to the overview (and starting point) for the new OpenAPI topics here: https://learn.microsoft.com/aspnet/core/fundamentals/openapi/overview.

I agree. The system provides a "this is the latest version" banner, but it's easy to miss and doesn't explain why. I think a brief explanation about these three ending with .NET 8 an OpenAPI taking over, in an alert box at the top of the page, would help a lot of people who might otherwise think there's something wrong with our version selection UI.