Swagger中@ApiIgnore注解的使用详解 Swagger中@ApiIgnore注解的使用详解

Swagger @ApiIgnore注解的使用

1、作用在类上时，整个类都会被忽略
2、当作用在方法上时，方法将被忽略
3、作用在参数上时，单个具体的参数会被忽略
4、在实体类中忽略不需要字段的方式

Swagger中的常用注解

1、作用在类上时，整个类都会被忽略
2、当作用在方法上时，方法将被忽略
3、作用在参数上时，单个具体的参数会被忽略

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

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

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

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

@Api(value = "https://www.it610.com/article/xxx", tags = "xxx",hidden = true)

当hidden为true时，该类隐藏。

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

@ApiIgnore@ApiOperation(value = "https://www.it610.com/article/xxx", httpMethod = "POST", notes = "xxx")@ApiImplicitParams({@ApiImplicitParam(name = "xxx", value = "https://www.it610.com/article/xxx", paramType = "query", dataType = "String", required = true)})@PostMapping("/xxx")public Result importCarryEquExcel(String xxx) {......}

隐藏某个方法还可以用@APIOperation注解自带的hidden属性：

@ApiOperation(value = "https://www.it610.com/article/xxx", httpMethod = "GET", notes = "xxx",hidden = true)

当hidden为true时，该方法隐藏。

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

public String abc(@ApiIgnore String a, String b, String c){return "a" + "b" + "c"; }

补充：

4、在实体类中忽略不需要字段的方式
（1）用@ApiModelProperty注解自带的hidden属性:

@ApiModelProperty(value = "https://www.it610.com/article/xxxid", required = true,hidden = true)private Long id;

（2）使用@JsonIgnore注解：

@ApiModelProperty(value = "https://www.it610.com/article/xxxid", required = true)@JsonIgnoreprivate Long id;

包名：

importcom.fasterxml.jackson.annotation.JsonIgnore;

Swagger中的常用注解使用swagger时

@ApiOperation表示生成API文档
@Apiignore表示忽略生成

@ApiIgnore 可以用在类、方法上，方法参数中，用来屏蔽某些接口或参数，使其不在页面上显示。
1、作用在类上时，整个类都会被忽略

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

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

@Api(value = "https://www.it610.com/article/xxx", tags = "xxx",hidden = true)当hidden为true时，该类隐藏

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

@ApiIgnore@ApiOperation(value = "https://www.it610.com/article/xxx", httpMethod = "POST", notes = "xxx")@ApiImplicitParams({@ApiImplicitParam(name = "xxx", value = "https://www.it610.com/article/xxx", paramType = "query", dataType = "String", required = true)})@PostMapping("/xxx")public Result importCarryEquExcel(String xxx) {......}

隐藏某个方法还可以用@APIOperation注解自带的hidden属性

@ApiIgnore@ApiOperation(value = "https://www.it610.com/article/xxx", httpMethod = "POST", notes = "xxx")@ApiImplicitParams({@ApiImplicitParam(name = "xxx", value = "https://www.it610.com/article/xxx", paramType = "query", dataType = "String", required = true)})@PostMapping("/xxx")public Result importCarryEquExcel(String xxx) {......}

隐藏某个方法还可以用@APIOperation注解自带的hidden属性：