@ApiOperationSupport是
时间: 2024-05-16 15:19:00 浏览: 12
`@ApiOperationSupport`是一个Swagger注解,用于在API文档中隐藏请求参数。为了在Swagger中使用`@ApiOperationSupport`注解来隐藏请求参数,你需要进行以下配置步骤:
1. 首先,你需要引入`knife4j-spring-boot-starter`依赖包,可以在你的项目的pom.xml文件中添加以下依赖:
```xml
<dependency>
<groupId>com.github.xiaoymin</groupId>
<artifactId>knife4j-spring-boot-starter</artifactId>
<version>2.0.2</version>
</dependency>
```
2. 然后,在Swagger的配置文件(一般是SwaggerConfig类)中,添加`@EnableKnife4j`注解,启用Knife4j的功能。
3. 现在,你可以在需要隐藏请求参数的接口上使用`@ApiOperationSupport`注解。该注解有一个`ignoreParameters`属性,可以指定需要忽略的参数列表。例如,你可以使用如下代码来隐藏`sysDict.id`和`sysDict.status`两个参数:
```java
@ApiOperation(value = "添加")
@ApiOperationSupport(ignoreParameters = {"sysDict.id,sysDict.status"})
@PostMapping("/add")
public R<Boolean> insert(@RequestBody SysDict sysDict) {
return success(this.sysDictService.save(sysDict));
}
```
通过以上配置,你可以在Swagger文档中看到该接口的文档时,忽略掉`sysDict.id`和`sysDict.status`这两个请求参数。<span class="em">1</span><span class="em">2</span><span class="em">3</span>
#### 引用[.reference_title]
- *1* [ApiOperationSupport注解的使用](https://blog.csdn.net/m0_54854484/article/details/123250673)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"]
- *2* *3* [常见的问题系列---【@ApiOperationSupport忽略失效的问题】](https://blog.csdn.net/weixin_44988127/article/details/130074545)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"]
[ .reference_list ]
相关推荐
![application/msword](https://img-home.csdnimg.cn/images/20210720083327.png)
![zip](https://img-home.csdnimg.cn/images/20210720083736.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)
![zip](https://img-home.csdnimg.cn/images/20210720083736.png)
![zip](https://img-home.csdnimg.cn/images/20210720083736.png)