feat: add overload IncludeMagicOnionXmlComments #978
Merged
mayuki merged 2 commits intoCysharp:mainfrom Sep 3, 2025
Merged
Conversation
Member
|
Thank you for contribution. Looks good to me! |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Swashbuckle's
IncludeXmlCommentshas overloads such as the following:https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/8f82acf800a8733a389328177d258186e947c20d/src/Swashbuckle.AspNetCore.SwaggerGen/DependencyInjection/SwaggerGenOptionsExtensions.cs#L839-L847
Furthermore, this overload is also used in the documentation.
https://github.com/domaindrivendev/Swashbuckle.AspNetCore/blob/8f82acf800a8733a389328177d258186e947c20d/docs/configure-and-customize-swaggergen.md?plain=1#L257
What it does is exactly the same as the current sample, but I personally prefer specifying the assembly as an argument (it requires slightly less typing). I'm also accustomed to this approach from Swashbuckle.
Therefore, I added an overload to the
IncludeMagicOnionXmlCommentsmethod that allows specifying an assembly, similar to Swashbuckle'sIncludeXmlComments.I've also updated the documentation to use this overload. (Though the original code might be preferable in documentation, as it explicitly shows loading the XML file.)
Thanks for the great library!