| 失效链接处理 |
|
Swagger 常用注解说明 PDF 下载
本站整理下载：
相关截图：
主要内容：
导入swagger包：import io.swagger.annotations.Api;
1、@API:用在请求的类上，表示对类的说明：
Tags=”说明该类的作用，可以在UI界面上看到的注解”
Value=”改参数没有什么意思，在UI界面上可以看到，所以不需要配置”
例如：@Api(tags = "用户操作Controller")
2、@ApiOperation:用在请求的方法上，说明方法的用途、作用
value=”说明方法的用户、作用”
Notes=”方法的备注说明”
例如：@ApiOperation(value = "保存用户信息",notes = "用户信息")
3、@ApiImplicitParams:用在请求的方法上，表示一组参数说明
@ApiImplicitParam:用在@ApiImplicitParamas注解中，指定一个请求参数的各个方面
Name:参数名称
Value:参数的汉字说明，解释
Required:参数是否必填
paramType:参数放在哪个地方
.header--->请求参数的获取：@RequestHeader
.query---->请求参数的获取：@RequestParam
.path(用于restful接口)--->请求参数的获取：@PathVariable
dataType：参数类型，默认String,可以设置为其他值dataType=”Integer”
defaultValue:参数默认值。
例如：
4、@ApiResponses:用在请求的方法上，表示一组响应。
@ApiResponse:用在@ApiResponses中，一般用于表达一个错误的响应信息。
Code:数字，例如200
Message:信息，例如：参数格式错误。
Response:抛出异常的类。
例如：
5、@ApiModel:用于响应类上，表示一个返回响应的数据的信息（一般用在post创建的时候，使用@RequestBody这样的场景，请求参数无法使用@ApiImplicitParam注解进行描述的时候）。
@ApiModelProperty:用在属性上，描述响应类的属性。
例如：
|
| Java1234官方群25： | 
|
| Java1234官方群25： | 838462530 |
苏公网安备 32061202001004号
