每日英文
Anyone else have no right to judge you, they may have heard things, but they feel less than what you experienced.
谁都无权评判你,他们也许听过你的事情,但他 们感受不到你所经历的一切 。
每日掏心话
人活一世最重要的是经历。时间,是距离也是宽恕,让一些东西更清晰,让一些感情更明白。
责编:乐乐 | 来自:youcongtech 链接:segmentfault.com/a/70506
编程技术圈(ID:study_tech)第 1209 次推文
往日回顾:全球最大成人网站 Pornhub 或将关停 !
正文
之前在创业公司待的时候,用过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二、添加配置类三、启动项目
调试相当于用PostMan测试接口。
搜索公众号后端架构师后台回复“架构整洁”,获取一份惊喜礼包。
四、常用注解
和swagger一样,swagger用的注解,swagger-bootstrap-ui仍能用。
不过结合我的开发经验来看,最常用的也就两个,@Api和@ApiOperation。
@Api的效果,如图:
由此,我们很容易就看出来,它们的含义是什么,一个是接口分类说明,一个是接口方法说明。
至于这里不用swagger的参数注解,主要原因是不想加太多的注解从而增加代码的数量,造成太多冗余。搜索Java知音公众号,回复“后端面试”,送你一份Java面试题宝典.pdf
例子中的Controller代码:
五、其它
关于swagger整合系列,可以参考如下:
https://www.cnblogs.com/youcong/p/9011302.html
关于swagger-bootstrap整合系列,可以参考:
https://www.cnblogs.com/youcong/p/9196157.html
https://www.cnblogs.com/youcong/p/10786371.html六、可能遇到的问题 1. 访问不到接口文档界面白版
一般是被拦截了(shiro或springsecurity机制)或者是配置错误。
2.访问接口文档界面出来了,但扫描不到接口
主要是配置类的缘故,配置类有个包扫描,必须配置为controller路径。
如图所示:
如果问题非常奇葩的话,实在解决不了(在参考官方文档说明和搜索的前提下,仍解决不了,把问题详细描述和关键性代码提到该开源项目的issue上,向创造者求助)。
PS:欢迎在留言区留下你的观点,一起讨论提高。如果今天的文章让你有新的启发,欢迎转发分享给更多人。
版权申明:内容来源网络,版权归原创者所有。除非无法确认,我们都会标明作者及出处,如有侵权烦请告知,我们会立即删除并表示歉意。谢谢!
嘿,你在看吗?
到此这篇swagger对比(swagger对比框架)的文章就介绍到这了,更多相关内容请继续浏览下面的相关推荐文章,希望大家都能在编程的领域有一番成就!版权声明:
本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。
如若内容造成侵权、违法违规、事实不符,请将相关资料发送至xkadmin@xkablog.com进行投诉反馈,一经查实,立即处理!
转载请注明出处,原文链接:https://www.xkablog.com/rfx/80598.html