SpringBoot怎样集成Swagger-UI
本篇文章为大家展示了Spring Boot怎样集成Swagger-UI，内容简明扼要并且容易理解，绝对能使你眼前一亮，通过这篇文章的详细介绍希望你能有所收获。
为龙口等地区用户提供了全套网页设计制作服务，及龙口网站建设行业解决方案。主营业务为做网站、网站制作、龙口网站设计，以传统方式定制建设网站，并提供域名空间备案等一条龙服务，秉承以专业、用心的态度为用户提供真诚的服务。我们深信只要达到每一位用户的要求，就会得到认可，从而选择与我们长期合作。这样，我们也可以走得更远！
Swagger-UI
下面介绍如何用spring boot集成Swagger-UI，实现项目在线接口文档的实现
一、Swagger-UI简介
Swagger是一个Restful风格接口的文档在线自动生成和测试的框架
官网对Swagger-UI的介绍：
简单的说就是：Swagger提供了一组静态页面，可以在SpringBoot应用中集成这些静态页面，直接访问静态页面，并打开指定的Swagger规范，就可以显示、测试调用接口：
而在SpringBoot中集成Swagger是非常容易的，仅需增加几个简单的注解。
效果如图：
二、pom 依赖
三、pom 配置Swagger2Config类
Swagger2Config类位于config包，用来配置swagger。
介绍一些简单的配置：
API接口文档的生成范围
Swagger对生成API文档的范围有三种不同的选择
生成指定包面的类的API文档下
生成有指定注解的类的API文档
生成有指定注解的方法的API文档
三种方式如图： 
配置页面信息
对应关系如图 
四、给交易类配置注解
常用注解
@Api：用于修饰Controller类，生成Controller相关文档信息
@ApiOperation：用于修饰Controller类中的方法，生成接口方法相关文档信息
@ApiParam：用于修饰接口中的参数，生成接口参数相关文档信息
@ApiModelProperty：用于修饰实体类的属性，当实体类是请求参数或返回结果时，直接生成相关文档信息
@Api
value - 字段说明
description - 注释说明这个类
对应：
@ApiOperation
value - 字段说明
notes - 注释说明
httpMethod - 说明这个方法被请求的方式
response - 方法的返回值的类型
@ApiModelProperty
value–字段说明
name–重写属性名字
dataType–重写属性类型
required–是否必填
example–举例说明
hidden–隐藏
@ApiResponse
code - 响应的HTTP状态码
message - 响应的信息内容
五、authorizations
如项目集成了OAuth3或JWT等 用户验证，不能直接调用需要添加 authorizations
可以从控制台拿到，添加后就可以自由调用
六、文档调用
http://localhost:8080/swagger-ui.html
看版本信息
http://localhost:8080/swagger-resources/
上述内容就是Spring Boot怎样集成Swagger-UI，你们学到知识或技能了吗？如果还想学到更多技能或者丰富自己的知识储备，欢迎关注创新互联行业资讯频道。
本文名称：SpringBoot怎样集成Swagger-UI
分享网址：http://shouzuofang.com/article/jsgeci.html