多应用+插件架构,代码干净,二开方便,首家独创一键云编译技术,文档视频完善,免费商用码云13.8K 广告
## 一、过滤显示的字段/对象 ### **问题来源** 后端基于开发的考虑,提交数据部分,基本上采取的是大颗粒度的参数(一般是***Post对象作为参数),该对象的结构一般一个模块一个,所以会比较复杂,子对象多,如果全部显示给前端,那么会造成困扰;如果采用细粒度参数,又会对后端代码的统一和平台化,带来麻烦; 基于以上的考虑,最优的方案是,接口用粗粒度对象,但文档中,曝露的仅仅是当前接口需要的参数,这样对前端就比较友好了; ### **解决方案** 定义api文档的时候,利用@ApiOperationSupport的ignoreParameters参数,即可实现目的; 举例如下 文档效果: 原对象中,有两个子对象,文档也如此显示: ![](https://img.kancloud.cn/1f/d5/1fd57bbda2673fd93705bbfdf4151680_968x145.png) 增加了配置 ![](https://img.kancloud.cn/e8/b5/e8b534451b7072593d28e5f55066b0fd_1230x203.png) 变成如下显示: ![](https://img.kancloud.cn/9a/bd/9abdaaa8908fd0fa097fe8bd5b1841a6_964x112.png) 可以看到,去掉了那个当前接口不需要的对象了;