feat: default flat param object #1805
Merged
+120
−51
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
bnasslahsen
added a commit
that referenced
this pull request
Aug 20, 2022
Charles7c
referenced
this pull request
in continew-org/continew-admin
Apr 8, 2023
1.使用 default-flat-param-object 全局设置对象型参数展示形式。此设置是在 springdoc-openapi v1.6.11 版本开始添加的新特性（详情请参阅：https://github.com/springdoc/springdoc-openapi/pull/1805），在此之前，只能在所有需要处理的对象型参数类上使用 @ParameterObject，工作量较大。 2.作者在使用上方这个配置时还遇到了一个 Bug，那就是只要在对象型参数前使用了注解，例如：@validated PageQuery pageQuery，这个配置就不会生效了。此问题已在 GitHub 提交了相应 issue（详情请参阅：https://github.com/springdoc/springdoc-openapi/issues/2181），并且 springdoc-openapi 社区某个小伙伴儿已在当前最新发布的 v2.1.0 和 v1.7.0 中修复。 注意：由于当前使用的 Knife4j 版本其内部引入的 springdoc-openapi 相关依赖非最新版本，所以为了解决配置不生效问题，暂时将部分对象型参数移除了 @validated 注解（除了 PageQuery，其他类当前也未实际添加校验，所以直接移除了）。当然如果不想移除的话，也可以从依赖上功夫，即移除 Knife4j 内引入的 springdoc-openapi 相关依赖，然后自行添加 springdoc-openapi 相关依赖并指定最新版本即可。
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.
I finished a version of the flattened parameter object, but there are still a few questions
MVC:
The default flattening causes test cases to fail. $ref has been changed to properties type, json cannot match. The fail use cases covered are 4, 13, 26, 71, 82, 93, 117, 140, 142
Other use cases have been successed with defaultFlatParamObject=true
WebFlux:
WebFlux uses a lot of Mono, and the flattening operations are in the core package, I'm not sure whether to separate the flattening operations into mvc and webflux.
In short, the behavior is unchanged from before when defaultFlatParamObject set false (default). the parameter object can be automatically flattened under mvc when defaultFlatParamObject set true, so that the description of the field and whether it is required can be viewed on swagger-ui. But defaultFlatParamObject can not set true in webflux.