Spring Mvc和SpringBoot整合Swagger2


各位同窗你们好,最近项目赶进度,没有钻研技术的时间,但碰巧今天须要在Spring项目上进行SpringMvc和Swagger的整合,而第一次使用Swagger是在SpringBoot项目上,所以踩了很多的坑,因而想和你们分享一下
:关于Swagger在SpringBoot或者和SpringMvc的集成!html


随着开发模式逐渐向先后端分离演变,沟通的成本逐渐增长,前端和后端的惟一联系,变成了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系用的挺多。工业上应该不咋用。json

 

swagger如今有两个版本,同时对应两种集成方式;版本1的swagger须要下载swagger-ui项目并导入本身的项目,致使项目臃肿且如今已不支持使用;所以咱们如今的集成是对swagger2而言;首先,英文名男咱们先讲解SpringBoot项目下的集成。后端

 

这里写图片描述

这里写图片描述

 

 

这里写图片描述


好了,作到这,关于swagger的集成算是完成了!有空也能够去研究一下swagger的其余用法,毕竟它仍是能提升咱们的开发效率。框架

相关文章
相关标签/搜索