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

技术领域

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

背景技术

传统的前后端对接方式，一般是后端人员定义好后端接口之后，人工整理成对应的文档，前端人员需要根据文档逐个接口属性确认然后对接。传统的前后端对接方式使用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(Remote Dictionary Server，远程字典服务)数据库中获取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(Application Programming Interface，应用程序接口)来始终保持同步。swagger让部署管理和使用功能强大的API变得非常简单。swagger是通过java(计算机编程语言)注解机制实现接口文档化的工具。

步骤S102、调用第一地址，以获取swagger接口的定义；

步骤S103、获取目标接口定义；其中，目标接口定义为后端接口的属性；

步骤S104、判断目标接口定义与swagger接口的定义是否相同，若否，则执行步骤S105；

步骤S105、获取第二地址，并根据第二地址，将swagger接口的定义自动导入至RAP2系统中并自动生成接口文档；其中，第二地址为RAP2系统中swagger接口对应的地址；

本实施例中，RAP2接口文档管理工具同时具有mock功能，RAP2是前后端开发解耦的神器，在前端开发过程中，我们需要实时与后端进行数据交互。然而大多数时候，前端开发都是在没有后端数据提供的情况下进行的，这时我们就需要用到假数据模拟。RAP2就是一款在线模拟数据生成器，可以拦截Ajax(一种网页开发技术)请求，其作用在于帮助前端工程师独立于后端进行开发，实现前后端分离。

步骤S106、经过预设时间之后返回步骤S101。

本实施例中，通过开源Quartz组件实现定时任务。

如图2所示，本实施例中，步骤S105中接口定义自动导入至RAP2系统中并自动生成接口文档的步骤包括：

步骤S1051、从redis数据库中获取cookie信息；

步骤S1052、发送swagger接口的定义的导入指令；

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

本实施例中，RAP2的登陆信息写在redis里，需要知道对应的redis数据库才能破解对应的登陆cookie信息达到自动登录的目的。由于rap2安全组件的限制，只有当用户自动登录时，才可发出获取第一地址指令，从而获取所述swagger接口的定义，进而将swagger接口的定义导入至RAP2系统中。

本实施公开了自动导入接口文档的方法，通过获取目标接口定义和swagger接口的定义，并判断目标接口定义与述swagger接口的定义是否相同，若不相同，则将swagger接口的定义自动导入至RAP2系统中并自动生成接口文档，从而实现了接口文档自动导入，进而提高接口文档导入的效率，维护便捷，保证了前后端开发沟通的实效性。

实施例2

如图3所示，本实施例公开了自动导入接口文档的系统，该系统包括：

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

本实施例中，swagger是一个规范和完整的框架，用于生成、描述、调用和可视化RESTful风格的Web服务。总体目标是使客户端和文件系统作为服务器以同样的速度来更新。文件的方法，参数和模型紧密集成到服务器端的代码，允许API来始终保持同步。swagger让部署管理和使用功能强大的API变得非常简单。swagger是通过java注解机制实现接口文档化的工具。

第二获取模块2，用于调用第一地址，以获取swagger接口的定义；

第三获取模块3，用于获取目标接口定义；其中，目标接口定义为后端接口的属性；

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

本实施例中，RAP2接口文档管理工具同时具有mock功能，RAP2是前后端开发解耦的神器，在前端开发过程中，我们需要实时与后端进行数据交互。然而大多数时候，前端开发都是在没有后端数据提供的情况下进行的，这时我们就需要用到假数据模拟。RAP2就是一款在线模拟数据生成器，可以拦截Ajax请求，其作用在于帮助前端工程师独立于后端进行开发，实现前后端分离。

返回模块5，用于经过预设时间之后调用第一获取模块1。

本实施例中，通过开源Quartz组件实现定时任务。

如图4所示，判断模块4还包括：

第一获取单元41，用于从redis数据库中获取cookie信息；

发送单元42，用于发送swagger接口的定义的导入指令；

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

本实施例中，RAP2的登陆信息写在redis里，需要知道对应的redis数据库才能破解对应的登陆cookie信息达到自动登录的目的。由于RAP2安全组件的限制，只有当用户自动登录时，才可发出获取第一地址指令，从而获取所述swagger接口的定义，进而将swagger接口的定义导入至RAP2系统中。

本实施公开了自动导入接口文档的系统，通过获取目标接口定义和swagger接口的定义，并判断目标接口定义与述swagger接口的定义是否相同，若不相同，则将swagger接口的定义自动导入至RAP2系统中并自动生成接口文档，从而实现了接口文档自动导入，进而提高接口文档导入的效率，维护便捷，保证了前后端开发沟通的实效性。

实施例3

图5为本发明实施例3提供的一种电子设备的结构示意图。所述电子设备包括存储器、处理器及存储在存储器上并可在处理器上运行的计算机程序，所述处理器执行所述程序时实现实施例1所提供的自动导入接口文档的方法。图5显示的电子设备30仅仅是一个示例，不应对本发明实施例的功能和使用范围带来任何限制。

如图5所示，电子设备30可以以通用计算设备的形式表现，例如其可以为服务器设备。电子设备30的组件可以包括但不限于：上述至少一个处理器31、上述至少一个存储器32、连接不同系统组件(包括存储器32和处理器31)的总线33。

总线33包括数据总线、地址总线和控制总线。

存储器32可以包括易失性存储器，例如随机存取存储器(RAM)321和/或高速缓存存储器322，还可以进一步包括只读存储器(ROM)323。

存储器32还可以包括具有一组(至少一个)程序模块324的程序/实用工具325，这样的程序模块324包括但不限于：操作系统、一个或者多个应用程序、其它程序模块以及程序数据，这些示例中的每一个或某种组合中可能包括网络环境的实现。

处理器31通过运行存储在存储器32中的计算机程序，从而执行各种功能应用以及数据处理，例如本发明实施例1所提供的自动导入接口文档的方法。

电子设备30也可以与一个或多个外部设备34(例如键盘、指向设备等)通信。这种通信可以通过输入/输出(I/O)接口35进行。并且，模型生成的设备30还可以通过网络适配器36与一个或者多个网络(例如局域网(LAN)，广域网(WAN)和/或公共网络，例如因特网)通信。如图所示，网络适配器36通过总线33与模型生成的设备30的其它模块通信。应当明白，尽管图中未示出，可以结合模型生成的设备30使用其它硬件和/或软件模块，包括但不限于：微代码、设备驱动器、冗余处理器、外部磁盘驱动阵列、RAID(磁盘阵列)系统、磁带驱动器以及数据备份存储系统等。

应当注意，尽管在上文详细描述中提及了电子设备的若干单元/模块或子单元/模块，但是这种划分仅仅是示例性的并非强制性的。实际上，根据本发明的实施方式，上文描述的两个或更多单元/模块的特征和功能可以在一个单元/模块中具体化。反之，上文描述的一个单元/模块的特征和功能可以进一步划分为由多个单元/模块来具体化。

实施例4

本实施例提供了一种计算机可读存储介质，其上存储有计算机程序，所述程序被处理器执行时实现实施例1所提供的自动导入接口文档的方法的步骤。

其中，可读存储介质可以采用的更具体可以包括但不限于：便携式盘、硬盘、随机存取存储器、只读存储器、可擦拭可编程只读存储器、光存储器件、磁存储器件或上述的任意合适的组合。

在可能的实施方式中，本发明还可以实现为一种程序产品的形式，其包括程序代码，当所述程序产品在终端设备上运行时，所述程序代码用于使所述终端设备执行实现实施例1所提供的自动导入接口文档的方法中的步骤。

其中，可以以一种或多种程序设计语言的任意组合来编写用于执行本发明的程序代码，所述程序代码可以完全地在用户设备上执行、部分地在用户设备上执行、作为一个独立的软件包执行、部分在用户设备上部分在远程设备上执行或完全在远程设备上执行。

虽然以上描述了本发明的具体实施方式，但是本领域的技术人员应当理解，这仅是举例说明，本发明的保护范围是由所附权利要求书限定的。本领域的技术人员在不背离本发明的原理和实质的前提下，可以对这些实施方式做出多种变更或修改，但这些变更和修改均落入本发明的保护范围。