gitee地址:https://gitee.com/yongrentongzhi/yongren-swagger-boot-starter
将项目打包安装在本地maven仓库后,输入依赖即可引入
最新版本为:1.2
完整配置项com.yongren yongren-swagger-boot-starter ${yongren-swagger-boot-starter.version}
yongren:
swagger:
properties:
docket-group:
product:
title: 商品模块API
group: 商品模块组
description: 描述了商品模块相关API
version: 1.0
contactInfo:
name: yongren
url: nothing
email: 3082046177@qq.com
basePackage: com.yongren.mall.product.controller
代码使用swagger注解,描述接口的方法。
| 注解 | 说明 |
|---|---|
| @Api | 用在请求的类上,例如Controller,表示对类的说明 |
| @ApiModel | 用在类上,通常是实体类,表示一个返回响应数据的信息 |
| @ApiModelProperty | 用在属性上,描述响应类的属性 |
| @ApiOperation | 用在请求的方法上,说明方法的用途、作用 |
| @ApiImplicitParams | 用在请求的方法上,表示一组参数说明 |
| @ApiImplicitParam | 用在@ApiImplicitParams注解中,指定一个请求参数的各个方面 |
url:port/doc.html



