How to use Microsoft.dotnet-openapi?

[doggy8088]

This issue was originally from #16158 and it's been closed by mistake.

I think the doc should address the Microsoft.dotnet-openapi's usage?

---

Document Details

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

• ID: 653e14ef-227e-a165-0360-2f59259e16c6
• Version Independent ID: e4685d05-e874-76a3-9780-66b864eca6c1
• Content: Develop ASP.NET Core apps using OpenAPI
• Content Source: aspnetcore/web-api/Microsoft.dotnet-openapi.md
• Product: aspnet-core
• Technology: aspnetcore-webapi
• GitHub Login: @ryanbrandenburg
• Microsoft Alias: rybrande

[wadepickett]

@doggy8088, Thanks for letting us know. I see the history of requests you are pointing back to and will address.

First, it is good to note the document was moved and its file name re-named at one point.
It now published here:
https://learn.microsoft.com/en-us/aspnet/core/fundamentals/openapi/openapi-tools?view=aspnetcore-9.0
Source:
https://github.com/dotnet/AspNetCore.Docs/blob/main/aspnetcore/fundamentals/openapi/openapi-tools.md

Some new topics have been published recently and other updated to expand on what we have available for samples and instruction:
Overview
Generate OpenAPI documents
Include OpenAPI metadata
Customize OpenAPI documents
Use OpenAPI documents
OpenAPI tools
Create a controller-based web AP - (Also shows how to use additional tooling to create ad hoc test pages for your API
Create a minimal web API

The last 3 topics in the list above show how to use additional tooling, both from Microsoft and others to quickly generate code and ad-hoc UI testing pages to consume the API from the client end, which is closest I think to what you were originally looking for.

Note that when you generate OpenAPI specification that it is best to not make it available on production. The examples above will show how to make it only available in a development environment, since it exposes details of the API you may not want public.

I will recreate this issue off of the document at its new location and name. That way tracking will work properly. I will include references to the old issues for the topic at the old location.

Also I will add in the issue that this reference type topic OpenAPI tools needs to clearly point to next step topics that show how to generate OpenAPI specification for your API and how to auto-create client code that demonstrates how to call the API based on the specification.

[wadepickett]

Closing this issue now, after reopening in #34786 so the work that needs to be addressed is now tracked with the new file name/location for this file, assigned a sprint for this to be addressed.