前言:
在调试一个项目的时候,用到了swagger工具,结果调bug出来了不少问题,所以深入的了解了一下这个工具,对这个工具也产生了不少兴趣。
Swagger2是什么?
在了解一个东西的时候,我们首先需要明确这个东西到底是做什么的,值不值得我们深入去了解。Swagger的出现简单来说就是为了解决一个问题:接口文档的生成。你可以通过它的规范来定义接口和接口文档相关的信息,然后生成各种各样的接口文档,以及生成各种语言的客户端与服务端代码,并且衍生出了在线测试接口,调试页面等功能。
刚开始swagger只是一套独立的规范,在开发新版本或者迭代的时候,通过更新swagger描述文件就可自动生成客户端服务端代码,可是这样的模式也可能会让开发人员遗忘更新描述文件,所以后续spring就整合swagger建立了一个Spring-swagger项目,也就是现在的springfox(swagger2),通过在项目里面引入springfox,可以自动扫描相关的代码生成描述文件。从而保证生成的Restful接口文档与前后端代码保持一致性。
Swagger2的优点
swagger2的优点自然不言而喻,它最大的优点是能实时同步api与文档,减轻开发人员的工作量与保证接口文档与后端代码的一致性,另外可以不需第三方工具在线测试。
关于缺陷这方面,我在网上查阅了很多资料,除开需要一部分开发工作量以外,好像其他缺点不明显,以后遇到会记录。
Swagger2的搭建
Swagger2-springboot的搭建以及使用:
https://blog.csdn.net/weixin_44146379/article/details/104825273?fps=1&locationNum=2
Swagger2-springMvc的搭建以及使用:
https://www.cnblogs.com/yuananyun/p/4993426.html
欢迎大家一起学习讨论。