springboot进阶学习（十三）springboot集成swagger-bootstrap-ui

springboot集成swagger-bootstrap-ui

• 上一节我们已经讲了swagger的基本用法，也可以实现文档自动生成和接口在线调试，但是页面稍微丑了点。为了让样式好看点，我们可以使用swagger-bootstrap-ui来让样式更加好看。
  swagger-bootstrap-ui从2.x版本开始引用方式变了，效果也变了，下面我们会讲解2.x和1.9.x版本的引用和使用。
• 这一节的所有代码都和上一节一样，只是引用的jar包和资源文件稍微有点变化

查看最新版本

我们可以去https://github.com/xiaoymin/Swagger-Bootstrap-UI/tags查看最新的资源文件，然后选择自己想要的版本资源。

为了演示效果，我分别选择了1.9.6版本和最新的2.0.3版本

引用jar包

• 因为使用了swagger-bootstrap-ui，所以不需要原本的springfox-swagger-uijar包，直接删除就行了
• 1.9.x版本引用方式

    <!--1.9.x版本的swagger-bootstrap-ui引用包方式如下 -->
    <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>swagger-bootstrap-ui</artifactId>
      <version>1.9.6</version>
    </dependency>

• 2.x版本引用方式，从2.x版本就改名叫knife4j-spring-ui了

    <!--2.x.x版本的swagger-bootstrap-ui引用包方式如下 1.9.x和2.x.x选择一个包引用就行-->
    <dependency>
      <groupId>com.github.xiaoymin</groupId>
      <artifactId>knife4j-spring-ui</artifactId>
      <version>2.0.3</version>
    </dependency>

运行

启动项目后，在浏览器输入http://localhost:8088/moyundong/doc.html就可以看到文档了

1.9.6版本运行效果如下图

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Wu1o6SPt-1594133035244)(http://47.94.137.150/moyundong/image/java/springboot2/springboot2-13-3.png)]

2.0.3版本运行效果如下图

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-MP2z7Lfv-1594133035248)(http://47.94.137.150/moyundong/image/java/springboot2/springboot2-13-4.png)]

不同

经过实际测试，切换样式就是这么简单，只是更换jar包就可以了，在网上看了很多例子，大部分都需要添加资源文件，有些是把资源文件放到resources底下，
有些是通过addResourceHandlers添加，两种做法分别如下：

1. 把第一步下载的资源文件直接放到resources底下的static文件夹下，我为了演示下载了两个版本
   

2. 添加资源文件

@Override
/**
 * SpringBoot中访问doc.html报404的解决办法
 */
@Configuration
public class SwaggerWebMvcConfigurer implements WebMvcConfigurer {
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("doc.html").addResourceLocations("classpath:/META-INF/resources/");
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
}

我试了下，不添加任何资源文件都是可以的，因为引入的jar包里面已经包含了所需的静态资源，有兴趣的可以把jar包解压，看看内容。
我猜测是有些项目不能直接访问静态资源文件，所以要使用addResourceHandlers方法。
::: warning 注意
这里是我测试的结果，大家也可以实际测试，看看到底要不要手动添加资源文件，实践出真知。
:::

总结

• 这一节我们没有修改任何java代码，只是修改了样式的jar包，文档效果就完全变了。
• 使用1.9.6还是2.0.3，我们只需要引用不同的jar包就行了，但是不能两个都引入
• 1.9.6与2.0.3界面效果不一样，根据自己喜好选择就行。

本节示例下载地址：java相关demo下载列表

1介绍
2springboot定时任务
3springboot定时任务配置详解
4springboot动态定时任务
5springboot集成websocket
6springboot多数据源
7springboot配置druid监听
8springboot自定义注解
9springboot常见注解详解
10springboot接收参数详解
11springboot验证机制@Valid和@Validated
12springboot集成Swagger2
13springboot集成swagger-bootstrap-ui
14springboot集成shiro
15springboot集成shiro（二）
16springboot集成jwt
17springboot集成ActiveMQ
18springboot缓存机制

🍉🍉🍉 欢迎大家来博客了解更多内容：java乐园 🍉🍉🍉