一种基于数据安全的API文档智能化生成与调试方法及系统

技术领域

本发明涉及智能代码开发技术领域，特别是涉及一种基于数据安全的API文档智能化生成与调试方法及系统。

背景技术

目前开发团队普遍采用前后端分离的开发形式，所以就需要API文档作为前端开发的辅助工具，因此就后端开发人员每开发完一个接口就需要在API文档中按照规定格式添加一个说明，前端开发人员拿到文档后首先要用第三方工具进行调试后再使用，并且要手动复制授权码、手动拼接参数后完成调试，由于人工书写接口，往往会出现错写、漏写参数的问题，如果涉及到接口修改，还需要反复修改文档，这个过程大幅降低了开发效率的同时也面临着接口暴露的数据安全问题。

发明内容

为解决上述后端人员手写文档、前端人员手动赋值授权码、拼接参数调试及接口暴露的数据安全问题，本发明提供了一种基于数据安全的API文档智能化生成与调试方法及系统，智能化生成与调试API文档，以提高API文档生成效率和准确率，确保数据安全。

为此，本发明提供了以下技术方案：

一方面，本发明公开了一种基于数据安全的API文档智能化生成方法，应用于后端，包括：

接收前端发送的获取API文档数据请求；

完成用户身份校验后，启动扫描程序，开始扫描当前项目下的所有层级的代码文件；

获取系统配置文件，根据所述配置文件生成所述代码文件中各API要素的API文档说明；所述配置文件中包括配置的开发团队的代码开发与注释规范、方法名和业务处理逻辑；

将生成的所有API文档说明放入数组中并转换为json格式，返回给前端，以便前端对所述API文档数据进行可视化展示。

进一步地，所述API文档说明包括：URL、请求参数、Request请求方法。

进一步地，启动扫描程序，开始扫描当前项目下的所有层级的代码文件，包括：

开始扫描文件内容；

扫描到@APINAME标识，代表一个API的开始，截取标识后面的API名称；

扫描到@param标识，代表一个请求参数，截取标识后面参数类型和参数名称；

扫描到@public function标识，代表对应API的方法体的开始，截取标识后面方法名称，系统根据方法名称、文件所在的路径，自动生成API对应的URL地址；

扫描到isPost()/isGet()标识，代表对应API需要用post方法还是用get方法请求，同时也代表一个API的结束；

如果文件中还有其他内容，则继续生成其他API说明。

进一步地，前端发送获取API文档数据请求，包括：

用户进入API文档UI界面，前端自动发送获取API文档数据请求。

进一步地，用户进入API文档UI界面之前，还包括：用户通过前端登录页面完成登录授权，获取身份授权码。

又一方面，本发明还公开了一种基于数据安全的API文档智能化生成方法，应用于前端，包括：

检测到用户进入API文档UI界面后，向后端发送获取API文档数据请求；以便后端接收到前端发送的获取API文档数据请求后，完成用户身份校验，启动扫描程序，开始扫描当前项目下的所有层级的代码文件；获取系统配置文件，根据所述配置文件生成所述代码文件中各API要素的API文档说明；所述配置文件中包括配置的开发团队的代码开发与注释规范、方法名和业务处理逻辑；将生成的所有API文档说明放入数组中并转换为json格式，返回给前端；

接收到后端反馈的数据后，对API文档数据进行可视化展示。

又一方面，本发明还公开了一种基于数据安全的API文档智能化调试方法，包括：

基于上述基于数据安全的API文档智能化生成方法生成API文档数据；

检测到用户点击前端对应API的调试按钮时，启动调试程序，调试程序根据API文档说明，自动生成请求参数并携带登录时的授权码向后端发起Request调用请求，并以源码格式显示后端相应的原始数据，以完成API调用。

本发明还公开了一种基于数据安全的API文档智能化生成系统，所述系统包括：

前端请求发送模块，用于检测到用户进入API文档UI界面后，向后端发送获取API文档数据请求；

前端展示模块，用于对后端生成并发送至前端的API文档数据进行可视化展示；

后端请求接收模块，用于接收前端发送的获取API文档数据请求；

后端扫描模块，用于完成用户身份校验后，启动扫描程序，开始扫描当前项目下的所有层级的代码文件；

后端文档生成模块，用于获取系统配置文件，根据所述配置文件生成所述代码文件中各API要素的API文档说明；所述配置文件中包括配置的开发团队的代码开发与注释规范、方法名和业务处理逻辑；

后端文档发送模块，用于将生成的所有API文档说明放入数组中并转换为json格式，返回给前端。

又一方面，本发明还公开了一种基于数据安全的API文档智能化调试系统，所述系统包括：

调试模块，基于上述API文档智能化生成系统生成API文档数据；检测到用户点击前端对应API的调试按钮时，启动调试程序，所述调试程序根据API文档说明，自动生成请求参数并携带登录时的授权码向后端发起Request调用请求，并以源码格式显示后端相应的原始数据，以完成API调用。

本发明的优点和积极效果：

在开发过程中通过基于数据安全的API文档智能化生成与调试系统使用，后端人员省去了书写API文档的过程，前端人员省去了使用第三方调试工具手动复制授权码、拼接参数的过程，后端人员写完函数方法后，系统就会自动生成对应的API数据，并在前端UI界面展示规范化的API接口文档，前端人员通过点击即可一键进行接口调试，由于系统已经形成标准化的API文档生成流程，故不会出现错写、漏写参数的问题、后端人员修改函数方法时，系统也会自动修改相应数据，也省去了反复修改文档的过程，以一个10个参数的查询API接口为例，完成API文档书写到前端完成调用，传统开发模式至少需要20分钟，而使用该系统后，整个过程只需要1分钟完成，效率提高了20倍，从而提高了团队整体的开发效率。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图做以简单地介绍，显而易见地，下面描述中的附图是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动性的前提下，还可以根据这些附图获得其他的附图。

图1为本发明实施例中一种基于数据安全的API文档智能化生成与调试方法的流程图；

图2为本发明实施例中生成每个API接口说明的流程图。

具体实施方式

为了使本技术领域的人员更好地理解本发明方案，下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分的实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都应当属于本发明保护的范围。

需要说明的是，本发明的说明书和权利要求书及上述附图中的术语“第一”、“第二”等是用于区别类似的对象，而不必用于描述特定的顺序或先后次序。应该理解这样使用的数据在适当情况下可以互换，以便这里描述的本发明的实施例能够以除了在这里图示或描述的那些以外的顺序实施。此外，术语“包括”和“具有”以及它们的任何变形，意图在于覆盖不排他的包含，例如，包含了一系列步骤或单元的过程、方法、系统、产品或设备不必限于清楚地列出的那些步骤或单元，而是可包括没有清楚地列出的或对于这些过程、方法、产品或设备固有的其它步骤或单元。

如图1所示，本发明实施例中一种基于数据安全的API文档智能化生成方法，具体包括：

S1、用户通过前端登录页面完成登录授权，获取身份授权码；

S2、进入API文档UI界面后，前端自动向后端发送获取API文档数据请求；

其中，UI即User Interface(用户界面)的简称。API，即Application ProgramInterface，应用程序接口，是一组定义、程序及协议的集合，通过API接口实现计算机软件之间的相互通信。API的一个主要功能是提供通用功能集。程序员通过调用API函数对应用程序进行开发，可以减轻编程任务。

S3、后端完成用户身份校验后，启动扫描程序，开始扫描当前项目下的所有层级的代码文件；

生成每个API接口说明的详细过程如图2所示，S3具体包括：

S3.1、开始扫描文件内容；

S3.2、扫描到@APINAME标识，代表一个API的开始，截取标识后面的API名称；

S3.3、扫描到@param标识，代表一个请求参数，截取标识后面参数类型和参数名称；

S3.4、扫描到@public function标识，代表对应API的方法体的开始，截取标识后面方法名称，系统根据方法名称、文件所在的路径，自动生成API对应的URL地址；

S3.5、扫描到isPost()/isGet()标识，代表对应API需要用post方法还是用get方法请求，同时也代表一个API的结束；

S3.6、如果文件中还有其他内容，则重复进行S3.1-S3.5继续生成其他API说明；

S3.7、如果文件中没有其他内容，将生成的所有API说明内容交给S4做后续处理。

S4、后端API文档数据生成程序根据开发团队的代码开发与注释规范、方法名、业务处理逻辑等自动生成包含URL、请求参数、Request请求方法等api要素的API说明；

S5、后端程序将生成的每个API放入数组中并转换为json格式，返回给前端；

S6、前端UI界面接收到到数据后，对API文档数据进行可视化展示。

在另一实施例中，在上述智能化生成API文档后，还可以对API文档进行调试，具体包括：

S7、用户点击前端对应API的调试按钮，启动调试程序，调试程序根据API文档说明，自动生成请求参数并携带登录时的授权码向后端发起Request调用请求，并以源码格式显示后端相应的原始数据，以完成API调用。

在另一实施例中，对应于上述实施例中一种基于数据安全的API文档智能化生成方法，还提供了一种基于数据安全的API文档智能化生成系统，该系统包括：

前端请求发送模块，用于检测到用户进入API文档UI界面后，向后端发送获取API文档数据请求；

前端展示模块，用于对后端生成并发送至前端的API文档数据进行可视化展示；

后端请求接收模块，用于接收前端发送的获取API文档数据请求；

后端扫描模块，用于完成用户身份校验后，启动扫描程序，开始扫描当前项目下的所有层级的代码文件；

后端文档生成模块，用于获取系统配置文件，根据所述配置文件生成所述代码文件中各API要素的API文档说明；所述配置文件中包括配置的开发团队的代码开发与注释规范、方法名和业务处理逻辑；

后端文档发送模块，用于将生成的所有API文档说明放入数组中并转换为json格式，返回给前端。

在另一实施例中，对应于上述实施例中一种基于数据安全的API文档智能化调试方法，还提供了一种基于数据安全的API文档智能化调试系统，该系统包括：

调试模块，基于上述API文档智能化生成系统生成API文档数据；检测到用户点击前端对应API的调试按钮时，启动调试程序，所述调试程序根据API文档说明，自动生成请求参数并携带登录时的授权码向后端发起Request调用请求，并以源码格式显示后端相应的原始数据，以完成API调用。

上述实施例中，基于数据安全的API文档智能化生成与调试系统适用于采用Vue和Tinkphp技术进行前后端分离的开发场景，首先要在系统配置文件中配置开发团队的代码开发与注释规范，前端配置API请求的域名地址以及登录授权接口的URL地址即完成所有基础配置，只需要通过vue-cli启动命令运行程序，即可进入系统UI界面，登录授权后自动进入API文档展示页面，开发人员通过点击页面可交互按钮，即可完成API接口URL地址的复制和接口的调试，API接口URL地址复制与接口调试的过程只需要1分钟结课完成，比传统流程提高了20倍，同时也提高了团队开发的整体效率。

最后应说明的是：以上各实施例仅用以说明本发明的技术方案，而非对其限制；尽管参照前述各实施例对本发明进行了详细的说明，本领域的普通技术人员应当理解：其依然可以对前述各实施例所记载的技术方案进行修改，或者对其中部分或者全部技术特征进行等同替换；而这些修改或者替换，并不使相应技术方案的本质脱离本发明各实施例技术方案的范围。