SpringBoot集成Swagger，更酷的UI方案

之前在创业公司待的时候，用过swagger，因为我第一天来这家公司工作，第一个任务就是做接口文档自动化。

后来觉得它不太好用，在浏览技术网站的时候，偶然发现swagger-bootstrap-ui，于是便重构了，把swagger-bootstrap-ui整合进来，后来发现不仅仅对我们后端有帮助，主要方便我们将接口进行归类，同样对安卓小伙伴也有帮助，他们可以看这个接口文档进行联调。当初我使用swagger-boostrap-ui的时候，那个时候还是1.x版本，如今swagger-bootsrap-ui到2.x，同时也更改名字knife4j，适用场景从过去的单体到微服务。也算是见证咱们国人自己的开源项目从小到大。

该开源项目GitHub地址:

https://github.com/xiaoymin/Swagger-Bootstrap-UI

该开源项目中文文档地址:

https://doc.xiaominfo.com

一、添加Maven依赖

二、添加配置类

三、启动项目

启动项目，不报错，然后访问地址:http://ip:port/doc.html 即可。

效果图，如下:

测试接口，效果图如下:

调试相当于用PostMan测试接口。

四、常用注解

和swagger一样，swagger用的注解，swagger-bootstrap-ui仍能用。不过结合我的开发经验来看，最常用的也就两个，@Api和@ApiOperation。@Api的效果，如图:

@ApiOperation的效果，如图:

由此，我们很容易就看出来，它们的含义是什么，一个是接口分类说明，一个是接口方法说明。至于这里不用swagger的参数注解，主要原因是不想加太多的注解从而增加代码的数量，造成太多冗余。

例子中的Controller代码:

五、其它

关于swagger-bootstrap整合系列，可以参考:

SpringBoot整合Swagger2，再也不用维护接口文档了！

用 Swagger 测试接口，怎么在请求头中携带 Token？

六、可能遇到的问题

访问不到接口文档界面白版

一般是被拦截了(shiro或springsecurity机制)或者是配置错误。

访问接口文档界面出来了，但扫描不到接口

主要是配置类的缘故，配置类有个包扫描，必须配置为controller路径。如图所示:

如果还有其它问题，可以去官方文档上找，官方文档有一个常规问题列表和解决方案，如图所示:

如果问题非常奇葩的话，实在解决不了(在参考官方文档说明和搜索的前提下，仍解决不了，把问题详细描述和关键性代码提到该开源项目的issue上，向创造者求助)。