写在前面
昨天我们说了swagger的一部分注解,了解到了如何注释controller类,还有如何注释视图模型、数据模型等等的注解,今天我们接着来看其他的一些注解。一起来看看吧。
Swagger常用的注解如何使用?
Swagger是什么我就不说了,大家可以去网上查一下即可。
现在来看一下如何Swagger的其他注解吧。
ApiIgnore注解
该注解,从名称来看,能分辨出这个注解是一种忽略功能,对的,就是忽略功能,如果你的Controller类不愿意向外暴露,那么就在类中引入这个注解。
这样的话,swagger就无法扫描出这个类的接口了。
ApiImplicitParams注解
该注解是为了给参数标明信息的,比如我们现在有一个查询接口,但是不是使用的Post请求,使用的是Get请求,后端只能通过request来获取。
这样的话,swagger就算再强大也没办法扫描出来参数是什么,这个时候就需要这个注解了,用来个性化展示参数值。
具体如何使用需要下面的注解一起搭配使用。
ApiImplicitParam注解
该注解需要上面的注解搭配使用,先看一个例子再说。
@ApiImplicitParams({ @ApiImplicitParam(paramType = "query", name = "username", value = "用户名称", dataType = "String", dataTypeClass = String.class), @ApiImplicitParam(paramType = "query", name = "age", value = "年龄", dataType = "int", dataTypeClass = Integer.class), })
使用ApiImplicitParams注解声明出一个集合,然后内部元素可以有多个ApiImplicitParam注解。
ApiImplicitParam注解还可以有paramType、name、value、dataType、dataTypeClass等参数。
paramType:标识此参数用于的位置,比如query、header等等
name:标识参数字段。
value:参数的描述信息就在这里写。
dataType:参数的数据类型。
dataTypeClass:参数的数据类型所使用的Class类,如果不加这个参数,启动会有一堆警告。
大概就是这个样子了,你学会了吗?
总结
今天我们又学习了swagger中的一些注解,swagger也就这几个注解,记住并不难,重要的是要懂得灵活运用才好,希望能帮到大家。