Spring与Swagger的整合
- 一. 新建项目
- 打开IDEA,点击File --> New --> Project,选择Spring Initializer
2. 填写Group和Artifact,默认也可以,选择自己使用的JDK版本
3. 选择依赖,可以选择Web
4. 项目名称、项目文件存在路径
5. 这样一个简单的Spring项目就创建好了,项目基本目录如下
- 二. 创建controller
- 启动类已经默认创建好了,我们只需要创建Controller
2. 配置文件application.properties可以不写,使用默认配置
3. 启动项目,浏览器输入链接
- 三. 引入Swagger依赖
引入的Swagger版本为2.8.0,版本不用太高;
如果用3.0.0的,注解@EnableSwagger2会找不到,后面打开swagger界面时会有问题。
- 四 . 添加swagger注解
@Api 是修饰整个类
@ApiOperation 修饰方法,用于描述一个方法
- 五. 编写swagger配置类
@EnableSwagger2 开启Swagger2的功能
apiInfo()方法:是API文档的描述信息
配置类中注入一个Docket的bean,包含apiInfo()和包扫描路径等基本信息
- 六. 打开Swagger界面
http://localhost:8080/swagger-ui.html
输入参数,测试接口