目录JAVA全系列 教程
3762个小节阅读：7093.9k
目录
C语言快速入门
JAVA全系列 教程
面向对象的程序设计语言
Python全系列 教程
Python3.x版本，未来主流的版本
人工智能 教程
顺势而为，AI创新未来
大厂算法 教程
算法，程序员自我提升必经之路
C++ 教程
一门通用计算机编程语言
微服务 教程
目前业界流行的框架组合
web前端全系列 教程
通向WEB技术世界的钥匙
大数据全系列 教程
站在云端操控万千数据
AIGC全能工具班
A A
White Night
ApiModelProperty
| 注解名称 | 参数 | 含义 |
|---|---|---|
| @ApiModelProperty | 一般用于方法、属性的说明 | |
| value | 字段说明 | |
| name | 重写属性名 | |
| required | 是否必须 | |
| example | 示例内容 | |
| hidden | 是否隐藏 |
代码示例：
xxxxxxxxxx@ApiModelProperty(value = "姓名", name = "name", required = true, example = "张三")private String name;
swagger-ui.html 效果展示
ApiIgnore
| 注解名称 | 含义 |
|---|---|
| @ApiIgnore | 用于方法或类或参数上，表示这个方法或类被忽略，和之前讲解的自定义注解@NotIncludeSwagger 效果类似。只是这个注解是 Swagger 内置的注解，而@NotIncludeSwagger 是我们自定义的注解 |
ApiImplicitParam
| 注解名称 | 参数 | 含义 |
|---|---|---|
| @ApiImplicitParam | 用在方法上，表示单独的请求参数，总体功能和@ApiParam 类似。 | |
| value | 对接口中的参数进行简单必要的描述 | |
| name | 描述接口中参数的名称 | |
| required | 是否必须 | |
| paramType | 接口中的参数应该用在哪个地方，常用的位置有：header、query 、path | |
| dataType | 接口中参数的类型 |
代码示例：
xxxxxxxxxx@PostMapping( "/getPeople")@ApiImplicitParam(name = "address",value = "地址",required = true,paramType = "query",dataType = "string" public People getPeople(Integer id, @ApiParam(value="姓名", required = true) String name, String address){ ...} swagger-ui.html 效果展示
如果希望在方法上配置多个参数时，使用@ApiImplicitParams 进行配置。示例如下：
xxxxxxxxxx@ApiImplicitParams(value={@ApiImplicitParam(name= "id",value = "编号",required = true),@ApiImplicitParam(name= "name",value = "姓名",required = true)})
实时效果反馈
1.swagger常用注解中写在方法上对方法进行描述的注解是
A ApiModelProperty
B ApiOperation
C ApiParam
D ApiModel
答案
1=>B