各位同学大家好,最近项目赶进度,没有钻研技术的时间,但碰巧今天需要在Spring项目上进行SpringMvc和Swagger的整合,而第一次使用Swagger是在SpringBoot项目上,因此踩了不少的坑,于是想和大家分享一下
:关于Swagger在SpringBoot或者和SpringMvc的集成!
随着开发模式逐渐向前后端分离演变,沟通的成本逐渐增加,前端和后端的唯一联系,变成了API接口;API文档变成了前后端开发人员联系的纽带,变得越来越重要,swagger就是一款让你更好的书写API文档的框架。
没有API文档工具之前,大家都是手写API文档的,在什么地方书写的都有,有在confluence上写的,有在对应的项目目录下readme.md上写的,每个公司都有每个公司的玩法,无所谓好坏。
书写API文档的工具有很多,但是能称之为“框架”的,估计也只有swagger了。
下面再细看看swagger的生态的具体内容:
1. swagger-ui这玩意儿从名字就能看出来,用来显示API文档的。和rap不同的是,它不可以编辑。
2.
swagger-editor就是一个在线编辑文档说明文件(swagger.json或swagger.yaml文件)的工具,以方便生态中的其他小工具(swagger-ui)等使用。
3. swagger-validator
这个小工具是用来校验生成的文档说明文件是否符合语法规定的。4. swagger-codegen
代码生成器,脚手架。可以根据swagger.json或者swagger.yml文件生成指定的计算机语言指定框架的代码。
有一定用处,Java系用的挺多。工业上应该不咋用。
swagger现在有两个版本,同时对应两种集成方式;版本1的swagger需要下载swagger-ui项目并导入自己的项目,导致项目臃肿且现在已不支持使用;因此我们现在的集成是对swagger2而言;首先,英文名男我们先讲解SpringBoot项目下的集成。
好了,做到这,关于swagger的集成算是完成了!有空也可以去研究一下swagger的其他用法,毕竟它还是能提高我们的开发效率。
原文地址:https://www.cnblogs.com/zhaolide/p/9946883.html