当前位置 : 主页 > 编程语言 > python >

SpringBoot+Swagger2常用注解

来源:互联网 收集:自由互联 发布时间:2023-03-22
场景 注: 关注公众号 霸道的程序猿 获取编程相关电子书、教程推送与免费下载。 实现 在上面使用Swagger实现可视化API之后,那么其常用注解有哪些。 @Api 作用在Controller类上,对请求

场景

注:

关注公众号 霸道的程序猿 获取编程相关电子书、教程推送与免费下载。

实现

在上面使用Swagger实现可视化API之后,那么其常用注解有哪些。

@Api

作用在Controller类上,对请求类的说明

示例:

SpringBoot+Swagger2常用注解_API

 

@ApiOperation

方法的说明

示例:

SpringBoot+Swagger2常用注解_ci_02

 

@ApiImplicitParams 和 @ApiImplicitParam

对方法参数的说明,单个用@ApiImplicitParam,多个用@ApiImplicitParams

示例:

单个参数

SpringBoot+Swagger2常用注解_程序猿_03

 

多个参数

SpringBoot+Swagger2常用注解_API_04

 

@ApiParam

对方法的参数进行说明

示例:

SpringBoot+Swagger2常用注解_swagger_05

 

@ApiModel

作用在JavaBean上,说明其用途。

有时参数为封装的JavaBean时,需要对此JavaBean进行说明

示例:

SpringBoot+Swagger2常用注解_程序猿_06

 

@ApiModelProperty

用在JavaBean类的属性上面,说明此属性的的含义

示例:

SpringBoot+Swagger2常用注解_ci_07

 

网友评论