springboot后台服务搭建(五 整合swagger)

总览:https://blog.csdn.net/qq_22037575/article/details/86687765

本文概要:springboot2.x 整合 swagger

码云:https://gitee.com/RichterGit/csdn/tree/master/springboot-radmin/005/

目录

1.pom导入依赖

2.全局配置

3.应用

4.访问接口文档


1.pom导入依赖

导入 swagger依赖


    io.springfox
    springfox-swagger2
    2.9.2


    io.springfox
    springfox-swagger-ui
    2.9.2


springboot后台服务搭建(五 整合swagger)_第1张图片

 

2.全局配置

新建一个 config包,用来存放配置类;并新建一个 swagger配置类 SwaggerConfig,设置只有使用了swagger注解的接口才会出现在接口文档中,否则接口文档中将会出现项目所有的接口信息

springboot后台服务搭建(五 整合swagger)_第2张图片

 

3.应用

在业务逻辑控制类,使用 swagger注解,这里要注意区分接口 @RequestMapping的请求方法,get、post等,如果不作区分,接口文档将会显示该接口的所有请求方法下的接口信息,这里新增一个测试方法 test()

springboot后台服务搭建(五 整合swagger)_第3张图片

4.访问接口文档

访问 http://localhost:8080/radmin/swagger-ui.html

springboot后台服务搭建(五 整合swagger)_第4张图片

 这里可以发现,如果接口的@RequestMapping的请求方法不做要求,将显示该接口的全部请求下的信息springboot后台服务搭建(五 整合swagger)_第5张图片

 这里测试下请求接口 /role/findAll,请求成功后状态码为200,返回 json数据springboot后台服务搭建(五 整合swagger)_第6张图片

 

你可能感兴趣的:(springboot后台服务搭建(五 整合swagger))