[发明专利]自动导入接口文档的方法、系统、设备和介质

说明书

本发明公开了一种自动导入接口文档的方法、系统、设备和介质，通过获取第一地址；所述第一地址为swagger接口地址；调用所述第一地址，以获取所述swagger接口的定义；获取目标接口定义；其中，所述目标接口定义为后端接口的属性；判断所述目标接口定义与所述swagger接口的定义是否相同，若否，则获取第二地址，并根据所述第二地址，将所述swagger接口的定义自动导入至RAP2系统中并自动生成接口文档；其中，所述第二地址为RAP2系统中所述swagger接口对应的地址。本发明实现了接口文档自动导入，从而提高接口文档导入的效率，维护便捷，保证了前后端开发沟通的实效性。

技术领域

本发明涉及及数据处理技术领域，特别涉及一种自动导入接口文档的方法、系统、设备和介质。

背景技术

传统的前后端对接方式，一般是后端人员定义好后端接口之后，人工整理成对应的文档，前端人员需要根据文档逐个接口属性确认然后对接。传统的前后端对接方式使用word(一种文档)文档，在线文档编辑的方式，效率低下，维护麻烦，而且还存在沟通时效性问题。为解决该问题，现有手段采用了swagger(一种开源组件)生成接口文档，将接口文档人工导入到RAP2(一种接口管理工具)系统中，并且通过人工确认接口文档是否有变化，这种人工确认和人工导入的方式存在当接口文档发生变化时，未确认出接口文档发生变化或者忘记将发生变化的接口文档导入到RAP2系统中。这种人工确认和人工导入的方式依然存在效率低下，维护麻烦，而且还存在沟通时效性问题。

发明内容

本发明要解决的技术问题是为了克服现有技术中接口文档导入效率低下，维护麻烦，沟通时效性低的的缺陷，提供一种自动导入接口文档、系统、设备和介质。

本发明是通过下述技术方案来解决上述技术问题：

本发明提供一种自动导入接口文档的方法，该方法包括：

S1.获取第一地址；该第一地址为swagger接口地址；

S2.调用所述第一地址，以获取swagger接口的定义；

S3.获取目标接口定义；其中，目标接口定义为后端接口的属性；

S4.判断所述目标接口定义与swagger接口的定义是否相同，若否，则获取第二地址，并根据第二地址，将swagger接口的定义自动导入至RAP2系统中并自动生成接口文档；其中，第二地址为RAP2系统中swagger接口对应的地址。

较佳地，将接口定义自动导入至RAP2系统中并自动生成接口文档的步骤包括：

从redis数据库中获取cookie(储存在用户本地终端上的数据)信息；

发送swagger接口的定义的导入指令；

根据导入指令，将swagger接口的定义导入至RAP2系统中并自动生成接口文档。

较佳地，判断目标接口定义与述swagger接口的定义是否有变化的步骤：

获取目标接口定义的第一目标接口字符串和swagger接口的定义的第一swagger接口字符串；

采用哈希算法将字符串进行数据处理，以获取第二目标接口字符串和第二swagger接口字符串；

将第二目标接口字符串和第二swagger接口字符串进行比较，判断第二目标接口字符串和第二swagger接口字符串是否相同。

较佳地，在步骤S4之后，自动导入接口文档的方法还包括：经过预设时间之后返回步骤S1。

本发明还提供一种自动导入接口文档的系统，该系统包括：

第一获取模块，用于获取第一地址；该第一地址为swagger接口地址；