kendouiapi中⽂⼿册_SpringBoot集成Swagger-Bootstrap-。。
。
之前在创业公司待的时候，⽤过swagger，因为我第⼀天来这家公司⼯作，第⼀个任务就是做接⼝⽂档⾃动化。
后来觉得它不太好⽤，在浏览技术⽹站的时候，偶然发现swagger-bootstrap-ui，于是便重构了，把swagger-bootstrap-ui整合进来，后来发现不仅仅对我们后端有帮助，主要⽅便我们将接⼝进⾏归类，同样对安卓⼩伙伴也有帮助，他们可以看这个接⼝⽂档进⾏联调。当初我使⽤swagger-boostrap-ui的时候，那个时候还是1.x版本，如今swagger-bootsrap-ui到2.x，同时也更改名字knife4j，适⽤场景从过去的单体到微服务。也算是见证咱们国⼈⾃⼰的开源项⽬从⼩到⼤。
该开源项⽬GitHub地址:
github/xiaoymin/Swa gger-Bootstrap-UI
该开源项⽬中⽂⽂档地址:
doc.xiaominfo/
⼀、添加Maven依赖springboot中文
<dependency>
⼆、添加配置类
package
三、启动项⽬
效果图，如下:
测试接⼝，效果图如下:
调式相当于⽤PostMan测试接⼝。
四、常⽤注解
和swagger⼀样，swagger⽤的注解，swagger-bootstrap-ui仍能⽤。
不过结合我的开发经验来看，最常⽤的也就两个，@Api和@ApiOperation。@Api的效果，如图:
@ApiOperation的效果，如图:
由此，我们很容易就看出来，它们的含义是什么，⼀个是接⼝分类说明，⼀个是接⼝⽅法说明。
⾄于这⾥不⽤swagger的参数注解，主要原因是不想加太多的注解从⽽增加代码的数量，造成太多冗余。
例⼦中的Controller代码:
package
五、其它
关于swagger整合系列，可以参考如下:
www. cnblogs/youcong/p/9 011302.html
关于swagger-bootstrap整合系列，可以参考:
www. cnblogs/youcong/p/9 196157.html www. cnblogs/youcong/p/1 0786371.html
六、可能遇到的问题
1.访问不到接⼝⽂档界⾯⽩版
⼀般是被拦截了(shiro或springsecurity机制)或者是配置错误。
2.访问接⼝⽂档界⾯出来了，但扫描不到接⼝
主要是配置类的缘故，配置类有个包扫描，必须配置为controller路径。
如图所⽰:
如果还有其它问题，可以去官⽅⽂档上，官⽅⽂档有⼀个常规问题列表和解决⽅案，如图所⽰:
如果问题⾮常奇葩的话，实在解决不了(在参考官⽅⽂档说明和搜索的前提下，仍解决不了，把问题详细描述和关键性代码提到该开源项⽬的issue上，向创造者求助)。

版权声明：本站内容均来自互联网，仅供演示用，请勿用于商业和其他非法用途。如果侵犯了您的权益请与我们联系QQ:729038198，我们将在24小时内删除。