ApiOperationSupport
时间: 2024-04-13 09:04:26 浏览: 15
@ApiOperationSupport是一个注解,用于在Swagger中隐藏请求参数。要使用@ApiOperationSupport注解,需要进行以下配置:
1. 在项目的pom.xml文件中引入依赖:
```xml
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.2</version>
</dependency>
```
2. 在Swagger配置类中添加@EnableKnife4j注解。
在控制器类中,可以在处理请求的方法上添加@ApiOperationSupport注解来配置请求参数的隐藏。当需要配置多个参数时,可以使用@ApiImplicitParams注解,并将其作为数组传递给@ApiOperationSupport注解的值。例如:
```java
@ApiOperation("删除品牌")
@ApiOperationSupport(order = 200)
@ApiImplicitParams({
@ApiImplicitParam(name = "id", value = "品牌id", required = true, dataType = "long")
})
@PostMapping("/delete")
public String delete(Long id) {
// 方法实现
}
```
此外,@ApiOperationSupport还可以配置order属性,用于指定业务接口的排序编号。同一个模块中的多个业务接口将按照order属性的升序排列。
综上所述,@ApiOperationSupport是一个用于隐藏请求参数的Swagger注解,可以通过配置依赖、添加注解和配置参数等方式来实现隐藏效果。
相关推荐
![zip](https://img-home.csdnimg.cn/images/20210720083736.png)
![application/msword](https://img-home.csdnimg.cn/images/20210720083327.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![](https://csdnimg.cn/download_wenku/file_type_ask_c1.png)
![dmg](https://img-home.csdnimg.cn/images/20210720083646.png)
![zip](https://img-home.csdnimg.cn/images/20210720083736.png)