说明:
项目地址在文章最后
本章代码所在分支为chapter30
代码规则:每章一个分支
后一章代码继承前一章代码
1 简介
前后端分离的时代,多了一层前后端接口对接,如图1.1所示。
这里讨论后端的变化,后端完成接口开发和自测后,
需要将接口同步给前端,进行联调、联测,
而,接口文档的承载有三种方式:
(1)手写接口文档(Word或PDF,给第三方使用);
(2)自动化接口文档(Swagger、YAPI、OpenAPI,团队内部使用);
(3)某网页(团队内部或第三方使用)。
本章讲解团队内部接口采集工具YAPI的应用。
与Swagger相比,
YAPI独立部署,与后台服务解耦,即无需占用后台服务内存资源(JVM),并且,同步接口信息时,仅需在IDEA中安装插件和YAPI平台配置项目Token,对后台项目零侵入;
Swagger需要集成到后台服务中,侵入性比较强,同时,启用Swagger查看接口文档时,占用后台服务内存资源(JVM)。