fix: 🐛 correct parameter documentation for @RequestBody and unannotated form parameters
#967
+258
−42
Conversation
This file contains 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
…ated form parameters Fixed an issue where unannotated parameters (e.g., BasePager) were incorrectly documented as part of the request body in API documentation when used alongside a @RequestBody parameter. These parameters are now correctly documented as query parameters. - Add ApiParamEnum to categorize API parameters (PATH, QUERY, BODY) - Implement logic to determine parameter type based on annotations and HTTP method - Update API documentation generation to use new parameter categorization - Refactor ApiMethodDoc and ApiParam classes for better parameter management - Improve handling of form data and query parameters in API requests Closes TongchengOpenSource#965
|
Thanks for your this PR. 🙏 In addition, if you have added new features, please provide example code in the repository smart-doc-group/smart-doc-example-cn. This will help other users understand how to use the new features. 感谢您提交的PR。 🙏 另外，如果您添加了新功能，请在仓库smart-doc-group/smart-doc-example-cn中提供示例代码。这将帮助其他用户了解如何使用新功能。 |
shalousun
approved these changes
Nov 26, 2024
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.
Fixed an issue where unannotated parameters (e.g., BasePager) were incorrectly documented as part of the request body in API documentation when used alongside a
@RequestBodyparameter. These parameters are now correctly documented as query parameters.Closes #965