自定义Swagger-ui简单又实用

自定义Swagger-ui简单又实用

前言：我刚接触Swagger-ui的时候，觉得这个东西真的很神奇，简单不要太方便了吧！！！今天把2.7.0的版本换成了2.9.2，发现除了我控制器的标注了api文档说明的居然还有其他一堆的参数说明，难道连底层里的方法也弄出来了，然后我就去百度找解决办法，我当时去百度搜关键词：swagger2的2.9.2版本的ui界面显示有问题，找了好久没解决办法，但是后面我看到一篇是自定义swagger-ui的博客，瞬间就觉得有额外的收获。哈哈，原生的ui简直太不好看了。于是我就赶紧试试。

1、先导入下面些依赖

<!--Swagger 是一个规范和完整的框架，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务。-->
<!--这个依赖是swagger2官方的是必须加的，它包含了一系列用来标注在类上和方法上并进行说明的注解-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger2</artifactId>
    <version>2.7.0</version>
</dependency>
<!--这个swagger-ui是官方提供的一个前端页面，用来查看并导出生成的api文档-->
<dependency>
    <groupId>io.springfox</groupId>
    <artifactId>springfox-swagger-ui</artifactId>
    <version>2.7.0</version>
</dependency>

因为第三方的swagger-ui的访问页面是和官方不同的，所以是可以共存的，下面是我找的3个第三方开发的swagger-ui页面，看起来都不错，依赖附上，记住是可以共存的哦，全部一起加入即可。

<!-- 引入swagger-bootstrap-ui包 /doc.html-->
<dependency>
    <groupId>com.github.xiaoymin</groupId>
    <artifactId>swagger-bootstrap-ui</artifactId>
    <version>1.9.1</version>
</dependency>
<!-- 引入swagger-ui-layer包 /docs.html-->
<dependency>
    <groupId>com.github.caspar-chen</groupId>
    <artifactId>swagger-ui-layer</artifactId>
    <version>1.1.3</version>
</dependency>
<!-- 引入swagger-ui-layer包 /document.html-->
<dependency>
    <groupId>com.zyplayer</groupId>
    <artifactId>swagger-mg-ui</artifactId>
    <version>1.0.6</version>
</dependency>

下面这两个依赖是在访问swagger-ui页面但是在后端控制台出现异常错误信息的时候加入就能解决

<!--增加两个配置-->
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-annotations</artifactId>
    <version>1.5.22</version>
</dependency>
<dependency>
    <groupId>io.swagger</groupId>
    <artifactId>swagger-models</artifactId>
    <version>1.5.22</version>
</dependency>

2、启动项目

进入浏览器输入以下地址进行访问，如果配置了项目的虚拟访问路径记得加上哦

• bootstrap-ui访问地址：http://ip地址:端口号/doc.html
  

• layer-ui访问地址：http://ip地址:端口号/docs.html
  

• mg-ui访问地址：http://ip地址:端口号/document.html
  
  如果出现了参数过多的情况，大多是版本太高了，我用的2.9.2就是参数过多的情况，不该出现的也出现了，这个时候换低版本的就行了，我用2.7.0是没有任何问题的。