Swagger中@ApiIgnore注解的使用详解

目录

一、Swagger @ApiIgnore注解的使用

1、作用在类上时，整个类都会被忽略

2、当作用在方法上时，方法将被忽略

3、作用在参数上时，单个具体的参数会被忽略

4、 在实体类中忽略不需要字段的方式

二、swagger 注解的使用解析

1.Swagger简介

2.常用注解

3.代码示例

---

这篇文章主要介绍了Swagger中@ApiIgnore注解的使用，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教。

一、Swagger @ApiIgnore注解的使用

@ApiIgnore 可以用在类、方法上，方法参数中，用来屏蔽某些接口或参数，使其不在页面上显示。

1、作用在类上时，整个类都会被忽略

@ApiIgnore
@Api(tags = {"Xxx控制类"})
@RestController
@RequestMapping("/xxx")
public class XxxController {
  ......
}

隐藏某个类还可以用@Api注解自带的hidden属性：

@Api(value = "xxx", tags = "xxx",hidden = true)