文章目录
- 前言
- 第一版对比功能说明
- 视频演示
前言
目前市面上主流的API管理工具在版本管理上，个人觉得做的比较粗糙，无法很直观的体现出版本之间差异，还停留在api元数据的文本比较上。用户更希望在浏览API文档阅读模式时能像word标注一样，很清晰的看到相对于指定版本修改了哪些内容。
为此，基于这块功能的缺憾，小卷带着两个兄弟开始自研包含强大的API版本管理的API管理工具，叫“ApiFirst”。
第一版对比功能说明
该工具第一版功能主要解决前后端对接或者三方对接时，由于api的提供方频繁修改api定义、更新版本，而对接方持有的还是很老的版本。这种对接的脱节，增加了对接方工作量。而如果他拿到最新的版本，并和手里的版本对比，很直观的看到哪些接口有变动，那么将大大的提升对接方因对接滞后的工作效率，最终也加速了项目完成的进度。
基于以上主要解决的场景，小卷带着爱徒完成了ApiFirst的产品雏形，后续会在此基础上继续开发和完善，并定期发布迭代的产品功能演示。初版为了快速出在线文档，使用thymeleaf后台模板技术来渲染，也因为没有用户交互，没有采用前后端分离的vue页面开发，界面略显简洁，但是对比功能还是很醒目的。
对比标注说明
绿色区域代表新增的内容，灰色代表删除的内容，蓝色背景代表有修改的内容，蓝色字体标注修改后的值，红色则标注修改前的值。正常的黑色字体则代表没有变化的部分。
因为thymeleaf模板还在开发，这里贴出半成品的页面截图：
api版本对比支持数据库任意两个版本的对比，另外也支持导入的oas3规范的yaml文件与数据库版本的对比，以及两个导入的yaml文件之间的对比。该功能将在后续的相关博文中加以说明。
视频演示
ApiFirst对比功能雏形演示视频地址：ApiFirst文档对比功能初版演示
最后，如果广大的小伙伴对该工具感兴趣，非常期待您提出宝贵的建议和意见！谢谢大家！
