我们在前面的源码过程中,了解了springfox的基本工作原理,接下来,我们可以通过使用springfox给我们提供的外部接口,来处理一些我们工作中碰到的问题,或者进行自定义扩展
本篇主要介绍如何来忽略某些特定的参数Class类型
先举一个例子,假如我们的接口是这样的:
@PostMapping("/createOr33der")
@ApiOperation(value = "创建订单")
public Rest<Order> createOrdetr(@RequestBody Order order, HttpSession httpSession){
Rest<Order> r=new Rest<>();
r.setData(order);
return r;
}
我们在我们的方法上接收了一个HttpSession
的参数对象,此时,我们来看我们的文档页面效果
在我们的文档介绍页面中,多出了很多我们自认为不必要的参数,因为HttpSession
对象我们并不需要传参处理,该对象我们是直接拿来使用对session进行操作的
那么,针对这种情况,我们应该如何处理呢(即把HttpSession的参数处理掉,不显示)?
目前有两种方法:
- 在方法的参数前,添加
@ApiIgnore
注解 - 在创建Docket对象时,指定忽略相关的Class