自动导入接口文档的方法、系统、设备和介质技术方案

本发明专利技术公开了一种自动导入接口文档的方法、系统、设备和介质，通过获取第一地址；所述第一地址为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接口地址；第二获取模块，用于调用第一地址，以获取swagger接口的定义；第三获取模块，用于获取目标接口定义；其中，目标接口定义为后端接口的属性；判断模块，用于判断目标接口定义与swagger接口的定义是否相同，若否，则获取第二地址，并根据第二地址，将swagger接口的定义自动导入至RAP2系统中并自动生成接口文档；其中，第二地址为RAP2系统中所述swagger接口对应的地址。较佳地，所述判断模块还包括：第一获取单元，用于从redis(RemoteDictionaryServer，远程字典服务)数据库中获取cookie信息；发送单元，用于发送swagger接口的定义的导入指令；导入单元，用于根据导入指令，将swagger接口的定义导入至RAP2系统中并自动生成接口文档。较佳地，判断模块还包括：第二获取单元，用于获取目标接口定义的第一目标接口字符串和swagger接口的定义的第一swagger接口字符串；第三获取单元，用于采用哈希算法将字符串进行数据处理，以获取第二目标接口字符串和第二swagger接口字符串；判断单元，用于将第二目标接口字符串和所述第二swagger接口字符串进行比较，判断第二目标接口字符串和所述第二swagger接口字符串是否相同。较佳地，自动导入接口文档的系统还包括：返回模块，用于经过预设时间之后调用第一获取模块。本专利技术还提供一种电子设备，包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述计算机程序时实现如前述的自动导入接口文档的方法。本专利技术还提供一种计算机可读存储介质，其上存储有计算机程序，所述计算机程序被处理器执行时实现如前述的自动导入接口文档的方法的步骤。本专利技术的积极进步效果在于：本专利技术提供一种自动导入接口文档的方法、系统、设备和介质，通过获取目标接口定义和swagger接口的定义，并判断目标接口定义与述swagger接口的定义是否相同，若不相同，则将swagger接口的定义自动导入至RAP2系统中并自动生成接口文档。本专利技术实现了接口文档自动导入，从而实现了提高接口文档导入的效率，维护便捷，保证了前后端开发沟通的实效性。附图说明图1为本专利技术实施例1的自动导入接口文档的方法的流程图；图2为本专利技术实施例1中步骤S105中接口定义自动导入至RAP2系统中并自动生成接口文档的流程图图3为本专利技术实施例2的自动导入接口文档的系统的模块示意图；图4为本专利技术实施例2的判断模块的模块示意图；图5为本专利技术实施例3的电子设备的结构示意图。具体实施方式下面通过实施例的方式进一步说明本专利技术，但并不因此将本专利技术限制在所述的实施例范围之中。实施例1如图1所示，本实施例公开了自动导入接口文档的方法，包括以下步骤：步骤S101、获取第一地址；该第一地址为swagger接口地址；本实施例中，swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful(一种网络应用程序的设计风格和开发方式)风格的Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API(ApplicationProgrammingInterface，应用程序接口)来始终保持同步。swagger让部署管理和使用功能强大的API变得非常简单。swagger是通过java(计算机编程语言)注解机制实现接口文档化的工具。步骤S102、调用第一地址，以获取swagger接口的定义；步骤S103、获取目标接口定义；其中，目标接口定义为后端接口的属性；步骤S104、判断目标接口定义与swagger接口的定义是否相同，若否，则执行步骤S105；步骤S105、获取第二地址，并根据第二地址，将swagger接口的定义自动导入至RAP2系统中并自动生成接口文档；其中，第二地址为RAP2系统中swagger接口对应的地址；本实施例中，RAP2接口文档管理工具同本文档来自技高网...

【技术保护点】
1.一种自动导入接口文档的方法，其特征在于，所述方法包括：/nS1.获取第一地址；所述第一地址为swagger接口地址；/nS2.调用所述第一地址，以获取所述swagger接口的定义；/nS3.获取目标接口定义；其中，所述目标接口定义为后端接口的属性；/nS4.判断所述目标接口定义与所述swagger接口的定义是否相同，若否，则获取第二地址，并根据所述第二地址，将所述swagger接口的定义自动导入至RAP2系统中并自动生成接口文档；其中，所述第二地址为RAP2系统中所述swagger接口对应的地址。/n

【技术特征摘要】
1.一种自动导入接口文档的方法，其特征在于，所述方法包括：
S1.获取第一地址；所述第一地址为swagger接口地址；
S2.调用所述第一地址，以获取所述swagger接口的定义；
S3.获取目标接口定义；其中，所述目标接口定义为后端接口的属性；
S4.判断所述目标接口定义与所述swagger接口的定义是否相同，若否，则获取第二地址，并根据所述第二地址，将所述swagger接口的定义自动导入至RAP2系统中并自动生成接口文档；其中，所述第二地址为RAP2系统中所述swagger接口对应的地址。


2.如权利要求1所述的自动导入接口文档的方法，其特征在于，所述将所述接口定义自动导入至RAP2系统中并自动生成接口文档的步骤包括：
从redis数据库中获取cookie信息；
发送所述swagger接口的定义的导入指令；
根据所述导入指令，将所述swagger接口的定义导入至所述RAP2系统中并自动生成接口文档。


3.如权利要求1所述的自动导入接口文档的方法，其特征在于，所述判断所述目标接口定义与所述swagger接口的定义是否有变化的步骤：
获取所述目标接口定义的第一目标接口字符串和所述swagger接口的定义的第一swagger接口字符串；
采用哈希算法将所述字符串进行数据处理，以获取第二目标接口字符串和第二swagger接口字符串；
将所述第二目标接口字符串和所述第二swagger接口字符串进行比较，判断第二目标接口字符串和所述第二swagger接口字符串是否相同。


4.如权利要求1所述的自动导入接口文档的方法，其特征在于，在步骤S4之后，所述方法还包括：经过预设时间之后返回步骤S1。


5.一种自动导入接口文档的系统，其特征在于，所述系统包括：
第一获取模块，用于获取第一地址；所述第一地址为swagger接口地址；
第二获取模块，用于调用所述第一地址，以获取所述swagger...

【专利技术属性】
技术研发人员：陈振华，任方铖，胡志明，宋海伟，蒋冲，王涛，洪庆祝，
申请(专利权)人：携程旅游信息技术上海有限公司，
类型：发明
国别省市：上海;31