Aspnetcore.docs: Swagger or OpenAPI

[Lamothe]

"OpenAPI is preferred" ... and that's the last time that OpenAPI is mentioned. It's "Swagger" all the way down. Just sayin'.

---

Document Details

⚠ Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.

• ID: f34eea37-51a4-6227-f5ed-6501624ad045
• Version Independent ID: 2994cf60-0cb7-afa2-20b8-7e2b1117f964
• Content: ASP.NET Core Web API help pages with Swagger / OpenAPI
• Content Source: aspnetcore/tutorials/web-api-help-pages-using-swagger.md
• Product: aspnet-core
• GitHub Login: @RSuter
• Microsoft Alias: scaddie

[Rick-Anderson]

@scottaddie this is fixed in your PR - right?

[RicoSuter]

For me personally Swagger is v2 and OpenAPI is v3 (but OpenAPI was also used in the v2 era). So essentially they can be used interchangeably but eventually we should only use OpenAPI - because Swagger is like a propriatery implementation of OpenAPI. The problem is that Swagger is much more known in the community...

[ppppersy]

good post!

[osca2000]

Nuget has got Microsoft.OpenAPI and Swagger. For API documentation, can we use Microsoft.OpenAPI only? Without Microsoft.OpenAPI, swagger does all. What is the role of Microsoft.OpenAPI then? I cannot find any sample of Microsoft.OpenAPI to do Swagger UI style documentation. In the past, visual studio api project did all this as default. But not anymore.