New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
[.NET 9]: Refactor and revise OpenAPI docs #32477
Comments
@martincostello What are your thoughts on the current Swashbuckle doc page (ref)? I think most of the content on there is accurate but some of the additional resources might be updated. @RicoSuter How about the NSwag page (ref)? I think the code generation section could use some sprucing. We don't mention the NSwag client generation via VS Connected services at all. And perhaps the screenshots need updating? |
@captainsafia Once we ship our 6.6.0 release with |
That sounds like a good idea to me! What are your thoughts on the amount of content that is on there? I'm not sure what the right balance between docs on this page and those we would link to externally in the Swashbuckle repo/elsewhere. |
I think the level of content there is fine - it seems to cover all the entry-level scenarios with a few troubleshooting hints. It might duplicate stuff that is (or should) be in our README, but I don't think there's anything in there that's out-of-date or incorrect from a quick scroll through. I did notice there's a link off to domaindrivendev/Swashbuckle.AspNetCore#1920 at the end of the document, which is resolved for 6.6.0, so that can be removed once we ship that too. |
@martincostello Great! TYSM for your help here. |
We're making some significant changes to the OpenAPI area in .NET 9. Namely:
As part of this, we'll want to refactor the docs on OpenAPI to reflect the state of the new universe.
AFAICT, we reference OpenAPI in a few pages in the docs:
As part of this work, I'm recommending a revised header structure for our OpenAPI-related docs.
The content under each of these pages should be the same, which conditional headers that allows us to show controller and minimal API specific code when necessary.
We'll also need to go in and revise any code blocks that reference
UseSwagger
/UseSwaggerUi
to reference the new built-in APIs.We'll probably want to have the first pass of this done to align with the preview4 release coming up in May. I'll create some draft content on the new APIs that we can incorporate here.
cc: @Rick-Anderson @tdykstra @JeremyLikness @mikekistler
The text was updated successfully, but these errors were encountered: