欢迎来到知嘟嘟! 联系电话:13095918853 卖家免费入驻,海量在线求购! 卖家免费入驻,海量在线求购!
知嘟嘟
我要发布
联系电话:13095918853
知嘟嘟经纪人
收藏
专利号: 2019109719003
申请人: 平安普惠企业管理有限公司
专利类型:发明专利
专利状态:授权未缴费
专利领域: 计算;推算;计数
更新日期:2024-03-22
缴费截止日期: 暂无
价格&联系人
年费信息
委托购买

摘要:

权利要求书:

1.一种接口文档生成方法,其特征在于,所述接口文档生成方法包括以下步骤:在接收到接口文档生成请求时,获取所述接口文档生成请求中的文件标识,及所述文件标识对应的代码文件;

根据所述代码文件的语言类型,对所述代码文件中的代码信息进行格式转化;

将格式转化后的所述代码信息与预设注释集合中的各预设注释信息进行比对,得到所述预设注释信息对应注释的接口代码;

将所述接口代码对应的预设注释信息作为目标注释信息,将所述接口代码和所述目标注释信息输入到预设文档模板中生成标准接口文档;

所述根据所述代码文件的语言类型,对所述代码文件中的代码信息进行格式转化的步骤,包括:确定所述代码文件的语言类型,查询预设编写规则库,获取所述预设编写规则库中所述语言类型对应的标准方法编写规则;

将所述代码信息中不符合所述标准方法编写规则的代码作为冗余代码,删除所述冗余代码以完成代码信息的格式转化;

所述将格式转化后的所述代码信息与预设注释集合中的各预设注释信息进行比对,得到所述预设注释信息对应注释的接口代码的步骤之前,包括:获取预设注释集合中的各预设注释信息,及各所述预设注释信息的特征字符串,根据所述特征字符串构建正则表达式;

所述将格式转化后的所述代码信息与预设注释集合中的各预设注释信息进行比对,得到所述预设注释信息对应注释的接口代码的步骤,包括:根据所述正则表达式检索所述代码信息,得到所述特征字符串对应的代码,并将所述代码作为预设注释信息对应注释接口代码。

2.如权利要求1所述的接口文档生成方法,其特征在于,所述将格式转化后的所述代码信息与预设注释集合中的各预设注释信息进行比对,得到所述预设注释信息对应注释的接口代码的步骤之前,包括:查询预设接口文档集合,获取所述预设接口文档集合中各预设接口文档中的接口注释信息,其中,所述接口注释信息包括:接口标识信息、接口调用信息、接口地址信息、接口功能信息、接口入参信息和接口返回值信息;

将所述接口注释信息转化为预设格式的接口注释信息,将所述预设格式的接口注释信息作为预设注释信息,并保存至预设注释集合。

3.如权利要求1所述的接口文档生成方法,其特征在于,所述将所述接口代码对应的预设注释信息作为目标注释信息,将所述接口代码和所述目标注释信息输入到预设文档模板中生成标准接口文档的步骤之后,包括:获取所述标准接口文档的文档标识,建立所述标准接口文档与所述文档标识的关联关系,并将所述文档标识添加至预设目录;

在接收到接口文档查询请求时,查询所述预设目录,获取所述接口文档查询请求对应的目标文档标识,根据所述目标文档标识的关联关系获取所述接口文档查询请求对应的目标接口文档并输出。

4.如权利要求1所述的接口文档生成方法,其特征在于,所述将所述接口代码对应的预设注释信息作为目标注释信息,将所述接口代码和所述目标注释信息输入到预设文档模板中生成标准接口文档的步骤之后,包括:在检测到所述代码文件更新时,比对更新前后的代码文件,获取更新的代码文件中的更新代码;

在所述更新代码是接口代码时,更新所述标准接口文档。

5.如权利要求1至4任意一项所述的接口文档生成方法,其特征在于,所述将所述接口代码对应的预设注释信息作为目标注释信息,将所述接口代码和所述目标注释信息输入到预设文档模板中生成标准接口文档的步骤之后,包括:在接收到测试用例生成请求时,获取所述测试用例生成请求中的文件标识,和所述文件标识对应的代码文件,判断是否存在与所述代码文件关联的标准接口文档;

若存在与所述代码文件存在关联的标准接口文档,则获取所述标准接口文档中的接口标识信息、接口入参信息和接口返回值信息;

将所述接口标识信息、所述接口入参信息和所述接口返回值信息输入至预设测试用例生成模型,生成测试用例;

在检测到测试用例生成完成时,将所述测试用例对应的验证参数输入至所述测试用例中,执行包含所述验证参数的测试用例,以校验所述测试用例;

在所述测试用例验证通过时,输出所述测试用例,以使用所述测试用例测试所述代码文件。

6.一种接口文档生成装置,其特征在于,所述接口文档生成装置包括:

请求接收模块,用于在接收到接口文档生成请求时,获取所述接口文档生成请求中的文件标识,及所述文件标识对应的代码文件;

代码转化模块,用于根据所述代码文件的语言类型,对所述代码文件中的代码信息进行格式转化;

代码比对模块,用于将格式转化后的所述代码信息与预设注释集合中的各预设注释信息进行比对,得到所述预设注释信息对应注释的接口代码;

文档生成模块,用于将所述接口代码对应的预设注释信息作为目标注释信息,将所述接口代码和所述目标注释信息输入到预设文档模板中生成标准接口文档;

所述代码转化模块,还用于确定所述代码文件的语言类型,查询预设编写规则库,获取所述预设编写规则库中所述语言类型对应的标准方法编写规则;将所述代码信息中不符合所述标准方法编写规则的代码作为冗余代码,删除所述冗余代码以完成代码信息的格式转化;

所述代码比对模块,还用于获取预设注释集合中的各预设注释信息,及各所述预设注释信息的特征字符串,根据所述特征字符串构建正则表达式;所述将格式转化后的所述代码信息与预设注释集合中的各预设注释信息进行比对,得到所述预设注释信息对应注释的接口代码的步骤,包括:根据所述正则表达式检索所述代码信息,得到所述特征字符串对应的代码,并将所述代码作为预设注释信息对应注释接口代码。

7.一种接口文档生成设备,其特征在于,所述接口文档生成设备包括:存储器、处理器及存储在所述存储器上并可在所述处理器上运行的计算机程序,其中:所述计算机程序被所述处理器执行时实现如权利要求1至5中任一项所述的接口文档生成方法的步骤。

8.一种计算机存储介质,其特征在于,所述计算机存储介质上存储有计算机程序,所述计算机程序被处理器执行时实现如权利要求1至5中任一项所述的接口文档生成方法的步骤。