@ApiOperation 注解是swagger里的,我们可以使用@ApiOperation注解来描述我们写的接口,该注解提供了很多属性供我们来描述接口信息。可供选择的属性如下:
属性名 | 属性类型 | 默认值 | 作用 |
---|---|---|---|
value() | String | 空 | 接口说明 |
tags() | String[] | 空 | 该接口属于什么分组 (可以是单个,也可以是多个) |
notes() | String | 空 | 接口的详细说明 |
httpMethod() | String | 空 | 接口请求方式 |
prodeces() | String | 空 | 接口请求头类型(输出) |
tags() | String[] | 空 | 该接口属于什么分组 (可以是单个,也可以是多个) |
nickname() | String | 空 | 接口别名 |
protocols() | String | 空 | 网络请求协议(http、https等) |
hidden() | boolean | false | 控制接口在Swagger界面中的显隐性 |
code() | int | 200 | 接口状态码 (一般不用设置,Swagger会自动生成接口返回状态) |
response() | Class<?> | 接口返回类型 | |
responseContainer() | String | 空 | 接口返回数据类型 |
responseReference() | String | 空 | 接口返回引用类型 |
consumes() | String | 空 | 接口请求头类型(输入) |