Aspnetcore.docs: How to use Microsoft.dotnet-openapi?

[doggy8088]

Is there any workable example that shown the Microsoft.dotnet-openapi's usage?

I totally have no idea how to use Microsoft.dotnet-openapi to generate client code.

---

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

[Rick-Anderson]

This is what we have. You might want to search other sites.

[doggy8088]

I really don't understand how to use the tool. I can't find any other useful information either. Is it possible to improve the doc?

[rafaelldi]

Hi,
call this comand dotnet openapi add url -p ./Client.csproj --output-file SomeApi.json http://localhost:5000/swagger/v1/swagger.json. It will generates SomeApiClient.cs partial class in the obj folder from the OpenAPI contract. After that, add an empty SomeApiClient to your project. Now, you can call API methods with SomeApiClient.
Here is my example project.

[doggy8088]

@rafaelldi It do works. Thanks for your example! I'm just thinking the doc should have more relevant context or contains more technical details.

[jkone27]

Can you guys re-open this? docs don't seem to explain exactly how to use it, or what it actually does: https://docs.microsoft.com/en-us/aspnet/core/web-api/microsoft.dotnet-openapi?view=aspnetcore-3.1

Very nice though! thanks

[Rick-Anderson]

Dup of #16158

[doggy8088]

@Rick-Anderson This issue is #16158 😅