SpringBoot接口标准工具Swag

swaggerlogo

简介以及解决问题

前后端分离作为当前项目开发的流向结构之一。前端主要是控制层和视图层,后端主要是控制层,业务层以及数据访问层。前后端主要通过各种API接口进行交互,并且相对独立且两端松耦合。

但是这个“前后端分离”会产生一个新的问题:前后端集成,前端或者后端无法做到“及时协商,尽早解决”,最后问题集中爆发。解决方法:制定相关的计划,并实时跟踪最新的API,降低集成风险。

Swagger简介:

号称世界上最流行的AP架RestfulApi文档在线自动生成器=API文档与API定义同步更新直接运行,在线测试API支持多种语言(如:Java,PHP等)项目搭建

我们使用idea+maven搭建项目,需要导入相关的依赖。

依赖导入

创建一个新的config配置类,配置swagger2

项目结构

我们在写swagger配置的类中,需要注意的是需要配置下图的选项

开启swagger2

我们配置一些个性化信息,在apiinfo中进行相关的定义:

个性化信息定制

我们需要把我们建立的个性化信息构造出来并将需要进行查看接口的包绑定进去。

主要的界面构造

下面我们可以看主要的swagger的UI界面:

项目主界面

这个就是本期的swagger的内容,我们可以使用它去同步前后端的内容,感谢大家的查看。




转载请注明:http://www.aierlanlan.com/tzrz/1438.html