Swagger中@ApiIgnore注解的使用详解

Swagger中@ApiIgnore注解的使用详解

目录Swagger @ApiIgnore注解的使用1、作用在类上时，整个类都会被忽略2、当作用在方法上时，方法将被忽略3、作用在参数上时，单个具体的参数会被忽略4、 在实体类中忽略不需要字段的方式swagger注解的使用Swagger简介常用注解代码示例

Swagger @ApiIgnore注解的使用

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

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

@ApiIgnore

@Api(tags = {"Xxx控制类"})

@RestController

@RequestMapping("/xxx")

public class XxxController {

......

}

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

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

当hidden为true时，该类隐藏。

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

@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注解自带的hidden属性：

@ApiOperation(value = "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 = "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简介

由于架构革新，进入了前后端分离，服务端只需提供RESTful API的时代。

而构建RESTful API会考虑到多终端的问题，这样就需要面对多个开发人员甚至多个开发团队。为了减少与其他团队对接的沟通成本，我们通常会写好对应的API接口文档。

从最早开始的word文档，到后续的showdoc，都能减少很多沟通成本，但随之带来的问题也比较麻烦。在开发期间接口会因业务的变更频繁而变动，如果需要实时更新接口文档，这是一个费时费力的工作。

为了解决上面的问题，Swagger应运而生。他可以轻松的整合进框架，并通过一系列注解生成强大的API文档。他既可以减轻编写文档的工作量，也可以保证文档的实时更新，将维护文档与修改代码融为一体，是目前较好的解决方案。

常用注解

@Api()用于类；

表示标识这个类是swagger的资源

@ApiOperation()用于方法；

表示一个http请求的操作

@ApiParam()用于方法，参数，字段说明；

表示对参数的添加元数据（说明或是否必填等）

@ApiModel()用于类

表示对类进行说明，用于参数用实体类接收

@ApiModelProperty()用于方法，字段

表示对model属性的说明或者数据操作更改

@ApiIgnore()用于类，方法，方法参数

表示这个方法或者类被忽略

@ApiImplicitParam() 用于方法

表示单独的请求参数

@ApiImplicitParams() 用于方法，包含多个 @ApiImplicitParam

代码示例

1、@Api

@Api(value = "用户博客", tags = "博客接口")

public class NoticeController {

}

2、@ApiOperation

@GetMapping("/detail")

@ApiOperation(value = "获取用户详细信息", notes = "传入notice" , position = 2)

public R detail(Integer id) {

Notice detail = noticeService.geXQnbIXCIGtOne(id);

return R.data(detail );

}

3、@ApiResponses

@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 detail(Integer id) {

Notice detail = noticeService.getOne(id);

return R.data(detail );

}

4、@ApiImplicitParams

以分页代码进行展示

IPage pages = noticeService.page(Condition.getPage(query), Condition.getQueryWrapper(notice, Notice.class));

@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> list(@ApiIgnore @RequestParam Map notice, Query query) {

IPage pages = noticeService.page(Condition.getPage(query), Condition.getQueryWrapper(notice, Notice.class));

return R.data(pages );

}

5、@ApiParam

@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);

}

6、@ApiModel 与 @ApiModelProperty

@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;

}

7、@ApiIgnore()

@ApiIgnore()

@GetMapping("/detail")

public R detail(Integer id) {

Notice detail = noticeService.getOne(id);

return R.data(detail );

}

版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。