Swagger中@ApiIgnore注解怎么用

這篇文章主要介紹了Swagger中@ApiIgnore注解怎么用，具有一定借鑒價(jià)值，感興趣的朋友可以參考下，希望大家閱讀完這篇文章之后大有收獲，下面讓小編帶著大家一起了解一下。

Swagger @ApiIgnore注解的使用

@ApiIgnore 可以用在類、方法上，方法參數(shù)中，用來屏蔽某些接口或參數(shù)，使其不在頁面上顯示。

1、作用在類上時(shí)，整個(gè)類都會(huì)被忽略

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

隱藏某個(gè)類還可以用@Api注解自帶的hidden屬性：

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

當(dāng)hidden為true時(shí)，該類隱藏。

2、當(dāng)作用在方法上時(shí)，方法將被忽略

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

隱藏某個(gè)方法還可以用@APIOperation注解自帶的hidden屬性：

@ApiOperation(value = "xxx", httpMethod = "GET", notes = "xxx",hidden = true)

當(dāng)hidden為true時(shí)，該方法隱藏。

3、作用在參數(shù)上時(shí)，單個(gè)具體的參數(shù)會(huì)被忽略

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

補(bǔ)充：

4、 在實(shí)體類中忽略不需要字段的方式

（1）用@ApiModelProperty注解自帶的hidden屬性:

@ApiModelProperty(value = "xxxid", required = true,hidden = true)
    private Long id;

（2）使用@JsonIgnore注解：

@ApiModelProperty(value = "xxxid", required = true)
    @JsonIgnore
    private Long id;

包名：

import  com.fasterxml.jackson.annotation.JsonIgnore;

Swagger中的常用注解

使用swagger時(shí)

• @ApiOperation表示生成API文檔

• @Apiignore表示忽略生成

@ApiIgnore 可以用在類、方法上，方法參數(shù)中，用來屏蔽某些接口或參數(shù)，使其不在頁面上顯示。

1、作用在類上時(shí)，整個(gè)類都會(huì)被忽略

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

隱藏某個(gè)類還可以用@Api注解自帶的hidden屬性：

@Api(value = "xxx", tags = "xxx",hidden = true)
當(dāng)hidden為true時(shí)，該類隱藏

2、當(dāng)作用在方法上時(shí)，方法將被忽略

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

隱藏某個(gè)方法還可以用@APIOperation注解自帶的hidden屬性

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

隱藏某個(gè)方法還可以用@APIOperation注解自帶的hidden屬性：

@ApiOperation(value = "xxx", httpMethod = "GET", notes = "xxx",hidden = true)

當(dāng)hidden為true時(shí)，該方法隱藏

3、作用在參數(shù)上時(shí)，單個(gè)具體的參數(shù)會(huì)被忽略

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

感謝你能夠認(rèn)真閱讀完這篇文章，希望小編分享的“Swagger中@ApiIgnore注解怎么用”這篇文章對(duì)大家有幫助，同時(shí)也希望大家多多支持億速云，關(guān)注億速云行業(yè)資訊頻道，更多相關(guān)知識(shí)等著你來學(xué)習(xí)!