一种基于数据安全的制造技术

本发明专利技术公开了一种基于数据安全的

【技术实现步骤摘要】
一种基于数据安全的API文档智能化生成与调试方法及系统


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

技术介绍

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

技术实现思路

[0003]为解决上述后端人员手写文档
、
前端人员手动赋值授权码
、
拼接参数调试及接口暴露的数据安全问题，本专利技术提供了一种基于数据安全的
API
文档智能化生成与调试方法及系统，智能化生成与调试
API
文档，以提高
API
文档生成效率和准确率，确保数据安全
。
[0004]为此，本专利技术提供了以下技术方案：
[0005]一方面，本专利技术公开了一种基于数据安全的
API
文档智能化生成方法，应用于后端，包括：
[0006]接收前端发送的获取
API
文档数据请求；
[0007]完成用户身份校验后，启动扫描程序，开始扫描当前项目下的所有层级的代码文件；
[0008]获取系统配置文件，根据所述配置文件生成所述代码文件中各
API
要素的
API
文档说明；所述配置文件中包括配置的开发团队的代码开发与注释规范
、
方法名和业务处理逻辑；
[0009]将生成的所有
API
文档说明放入数组中并转换为
json
格式，返回给前端，以便前端对所述
API
文档数据进行可视化展示
。
[0010]进一步地，所述
API
文档说明包括：
URL、
请求参数
、Request
请求方法
。
[0011]进一步地，启动扫描程序，开始扫描当前项目下的所有层级的代码文件，包括：
[0012]开始扫描文件内容；
[0013]扫描到
@API\NAME
标识，代表一个
API
的开始，截取标识后面的
API
名称；
[0014]扫描到
@param
标识，代表一个请求参数，截取标识后面参数类型和参数名称；
[0015]扫描到
@public function
标识，代表对应
API
的方法体的开始，截取标识后面方法名称，系统根据方法名称
、
文件所在的路径，自动生成
API
对应的
URL
地址；
[0016]扫描到
isPost()/isGet()
标识，代表对应
API
需要用
post
方法还是用
get
方法请求，同时也代表一个
API
的结束；
[0017]如果文件中还有其他内容，则继续生成其他
API
说明
。
[0018]进一步地，前端发送获取
API
文档数据请求，包括：
[0019]用户进入
API
文档
UI
界面，前端自动发送获取
API
文档数据请求
。
[0020]进一步地，用户进入
API
文档
UI
界面之前，还包括：用户通过前端登录页面完成登录授权，获取身份授权码
。
[0021]又一方面，本专利技术还公开了一种基于数据安全的
API
文档智能化生成方法，应用于前端，包括：
[0022]检测到用户进入
API
文档
UI
界面后，向后端发送获取
API
文档数据请求；以便后端接收到前端发送的获取
API
文档数据请求后，完成用户身份校验，启动扫描程序，开始扫描当前项目下的所有层级的代码文件；获取系统配置文件，根据所述配置文件生成所述代码文件中各
API
要素的
API
文档说明；所述配置文件中包括配置的开发团队的代码开发与注释规范
、
方法名和业务处理逻辑；将生成的所有
API
文档说明放入数组中并转换为
json
格式，返回给前端；
[0023]接收到后端反馈的数据后，对
API
文档数据进行可视化展示
。
[0024]又一方面，本专利技术还公开了一种基于数据安全的
API
文档智能化调试方法，包括：
[0025]基于上述基于数据安全的
API
文档智能化生成方法生成
API
文档数据；
[0026]检测到用户点击前端对应
API
的调试按钮时，启动调试程序，调试程序根据
API
文档说明，自动生成请求参数并携带登录时的授权码向后端发起
Request
调用请求，并以源码格式显示后端相应的原始数据，以完成
API
调用
。
[0027]本专利技术还公开了一种基于数据安全的
API
文档智能化生成系统，所述系统包括：
[0028]前端请求发送模块，用于检测到用户进入
API
文档
UI
界面后，向后端发送获取
API
文档数据请求；
[0029]前端展示模块，用于对后端生成并发送至前端的
API
文档数据进行可视化展示；
[0030]后端请求接收模块，用于接收前端发送的获取
API
文档数据请求；
[0031]后端扫描模块，用于完成用户身份校验后，启动扫描程序，开始扫描当前项目下的所有层级的代码文件；
[0032]后端文档生成模块，用于获取系统配置文件，根据所述配置文件生成所述代码文件中各
API
要素的
API
文档说明；所述配置文件中包括配置的开发团队的代码开发与注释规范
、
方法名和业务处理逻辑；
[0033]后端文档发送模块，用于将生成的所有
API
文档说明放入数组中并转换为本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.
一种基于数据安全的
API
文档智能化生成方法，其特征在于，应用于后端，包括：接收前端发送的获取
API
文档数据请求；完成用户身份校验后，启动扫描程序，开始扫描当前项目下的所有层级的代码文件；获取系统配置文件，根据所述配置文件生成所述代码文件中各
API
要素的
API
文档说明；所述配置文件中包括配置的开发团队的代码开发与注释规范
、
方法名和业务处理逻辑；将生成的所有
API
文档说明放入数组中并转换为
json
格式，返回给前端，以便前端对所述
API
文档数据进行可视化展示
。2.
根据权利要求1所述的一种基于数据安全的
API
文档智能化生成方法，其特征在于，所述
API
文档说明包括：
URL、
请求参数
、Request
请求方法
。3.
根据权利要求1所述的一种基于数据安全的
API
文档智能化生成与调试方法，其特征在于，启动扫描程序，开始扫描当前项目下的所有层级的代码文件，包括：开始扫描文件内容；扫描到
@API\NAME
标识，代表一个
API
的开始，截取标识后面的
API
名称；扫描到
@param
标识，代表一个请求参数，截取标识后面参数类型和参数名称；扫描到
@public function
标识，代表对应
API
的方法体的开始，截取标识后面方法名称，系统根据方法名称
、
文件所在的路径，自动生成
API
对应的
URL
地址；扫描到
isPost()/isGet()
标识，代表对应
API
需要用
post
方法还是用
get
方法请求，同时也代表一个
API
的结束；如果文件中还有其他内容，则继续生成其他
API
说明
。4.
根据权利要求1所述的一种基于数据安全的
API
文档智能化生成方法，其特征在于，前端发送获取
API
文档数据请求，包括：用户进入
API
文档
UI
界面，前端自动发送获取
API
文档数据请求
。5.
根据权利要求4所述的一种基于数据安全的
API
文档智能化生成方法，其特征在于，用户进入
API
文档
UI
界面之前，还包括：用户通过前端登录页面完成登录授权，获取身份授权码
。6.
一种基于数据安全的
API
文档智能化生成方法，其特征在于，应用于前端，包括：检测到用户进入
API
...

【专利技术属性】
技术研发人员：王家文，
申请(专利权)人：大连佳佰讯物联网产业有限公司，
类型：发明
国别省市：