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

想了解Swagger中@ApiIgnore注解的使用详解的相关内容吗，周公解码在本文为您仔细讲解Swagger @ApiIgnore注解的相关知识和一些Code实例，欢迎阅读和指正，我们先划重点：Swagger注解,@ApiIgnore注解，下面大家一起来学习吧。

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

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

@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) {
    ......
}

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

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

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

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

import  com.fasterxml.jackson.annotation.JsonIgnore;

@Api(value = "用户博客", tags = "博客接口")
public class NoticeController { 
}

@GetMapping("/detail")
@ApiOperation(value = "获取用户详细信息", notes = "传入notice" , position = 2)
public R<Notice> detail(Integer id) {
   Notice detail = noticeService.getOne(id);
   return R.data(detail );
}

@ApiResponses(value = {@ApiResponse(code = 500, msg= "INTERNAL_SERVER_ERROR", response = R.class)})
@GetMapping("/detail")
@ApiOperation(value = "获取用户详细信息", notes = "传入notice" , position = 2)
@ApiResponses(value = {@ApiResponse(code = 500, msg= "INTERNAL_SERVER_ERROR", response = R.class)})
public R<Notice> detail(Integer id) {
   Notice detail = noticeService.getOne(id);
   return R.data(detail );
}

@GetMapping("/list")
@ApiImplicitParams({
   @ApiImplicitParam(name = "category", value = "公告类型", paramType = "query", dataType = "integer"),
   @ApiImplicitParam(name = "title", value = "公告标题", paramType = "query", dataType = "string")
})
@ApiOperation(value = "分页", notes = "传入notice", position = 3)
public R<IPage<Notice>> list(@ApiIgnore @RequestParam Map<String, Object> notice, Query query) {
     IPage<Notice> pages = noticeService.page(Condition.getPage(query), Condition.getQueryWrapper(notice, Notice.class));
   return R.data(pages );
}

@PostMapping("/remove")
@ApiOperation(value = "逻辑删除", notes = "传入notice", position = 7)
public R remove(@ApiParam(value = "主键集合") @RequestParam String ids) {
   boolean temp = noticeService.deleteLogic(Func.toIntList(ids));
   return R.status(temp);
}

@Data
@ApiModel(value = "BladeUser ", description = "用户对象")
public class BladeUser implements Serializable { 
   private static final long serialVersionUID = 1L; 
   @ApiModelProperty(value = "主键", hidden = true)
   private Integer userId;
 
   @ApiModelProperty(value = "昵称")
   private String userName;
 
   @ApiModelProperty(value = "账号")
   private String account;
 
   @ApiModelProperty(value = "角色id")
   private String roleId;
 
   @ApiModelProperty(value = "角色名")
   private String roleName; 
}

@ApiIgnore()
@GetMapping("/detail")
public R<Notice> detail(Integer id) {
   Notice detail = noticeService.getOne(id);
   return R.data(detail );
}