fullstackhero / dotnet-starter-kit

Production Grade Cloud-Ready .NET 8 Starter Kit (Web API + Blazor Client) with Multitenancy Support, and Clean/Modular Architecture that saves roughly 200+ Development Hours! All Batteries Included.

Home Page:https://fullstackhero.net/dotnet-webapi-boilerplate/

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

[BUG] [v2] Swagger WithSummary / WithDescription metadata doesnt show up on the UI

iammukeshm opened this issue · comments

Hello @iammukeshm , I quickly took a look. I saw this issue was present with .NET7 (dotnet/aspnetcore#40753). I don't know if the issue has been correctly fixed.

Inside comments, it is indicated to use WithOpenApi to get around the problem. I tested and it works.

WithOpenApi
WithOpenApi-Result

Hi @fcantenot, I have seen something similar to this, and tried fixing it. I was able to make the Swagger UI display the correct summary and description, but I was not able to hit the API endpoint. It was giving me a 404 exception. Are you able to access the APIs? If so, can you please take the latest changes from v2 and raise a new PR with this fix?

domaindrivendev/Swashbuckle.AspNetCore#2414

I think this is the fix for this issue. Let's see if this gets merged anytime soon!

Hi @fcantenot, I have seen something similar to this, and tried fixing it. I was able to make the Swagger UI display the correct summary and description, but I was not able to hit the API endpoint. It was giving me a 404 exception. Are you able to access the APIs? If so, can you please take the latest changes from v2 and raise a new PR with this fix?

sorry @iammukeshm , I tried but we have an error like you mentioned.
If we use "WithSummary&WithDescription", versioning is ok (see curl command) but not summary and description.
WithSummary

If we use "WithOpenApi", summary & description are ok but versioning is ko as you can see with the curl command
WithOpenApi

I searched but it seems it is also a bug or I don't know how to get around.
dotnet/aspnet-api-versioning#953

Hey 👋🏼
domaindrivendev/Swashbuckle.AspNetCore#2414 has now merged, and looks like it is going to be in Swashbuckle.AspNetCore v6.5.1