场景
SpringBoot+Swagger2实现可视化API文档流程:
https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/93616618
SpringBoot+MyBatisPlus+Swagger2.7规范开发接口流程(以废料包材入库与出库为例):
https://blog.csdn.net/BADAO_LIUMANG_QIZHI/article/details/93875338
注:
博客:
https://blog.csdn.net/badao_liumang_qizhi
关注公众号
霸道的程序猿
获取编程相关电子书、教程推送与免费下载。
实现
在上面使用Swagger实现可视化API之后,那么其常用注解有哪些。
@Api
作用在Controller类上,对请求类的说明
示例:
@ApiOperation
方法的说明
示例:
@ApiImplicitParams 和 @ApiImplicitParam
对方法参数的说明,单个用@ApiImplicitParam,多个用@ApiImplicitParams
示例:
单个参数
多个参数
@ApiParam
对方法的参数进行说明
示例:
@ApiModel
作用在JavaBean上,说明其用途。
有时参数为封装的JavaBean时,需要对此JavaBean进行说明
示例:
@ApiModelProperty
用在JavaBean类的属性上面,说明此属性的的含义
示例: