首页 专利交易 科技果 科技人才 科技服务 国际服务 商标交易 会员权益 IP管家助手 需求市场 关于龙图腾
 /  免费注册
到顶部 到底部
清空 搜索

一种接口文档更新方法、装置、电子设备及存储介质 

买专利卖专利找龙图腾,真高效! 查专利查商标用IPTOP,全免费!专利年费监控用IP管家,真方便!

申请/专利权人:平安科技(深圳)有限公司

摘要:本发明实施例公开了一种接口文档更新方法、装置、电子设备及存储介质,其中方法包括:根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,获取所述目标模块中被更新的代码,及所述目标模块的接口文档,从所述被更新的代码对应的代码注释信息中提取接口信息,对提取到的接口信息进行格式处理,得到处理后的接口信息,根据所述处理后的接口信息更新所述目标模块的接口文档,得到更新后的接口文档。可实时更新模块的接口文档,以便可以较准确验证该模块的功能。

主权项:1.一种接口文档更新方法,其特征在于,包括:当预设的规则包括根据模块的时间戳时,获取代码数据库中每个模块上一次更新的第一时间戳,及每个所述模块对应的接口文档上一次更新的第二时间戳;将所述代码数据库中所述第一时间戳与所述第二时间戳之间的差值大于预设阈值的模块确定为代码被更新的目标模块;获取所述目标模块的接口文档,以及获取开发所述目标模块的设备的系统日志数据,根据所述目标模块的标识从所述系统日志数据中提取关于该目标模块的日志数据,从所述目标模块的日志数据中,获取所述目标模块中被更新的代码,所述被更新的代码为所述目标模块中被删除的代码、新增的代码及被替换的代码中的至少一种;从所述被更新的代码对应的代码注释信息中提取接口信息,获取所述目标模块中的代码类型;根据所述目标模块中的代码类型确定用于测试所述目标模块的测试用例的格式;根据所述测试用例的格式对提取到的接口信息进行处理,得到处理后的接口信息,所述代码注释信息用于解释所述被更新的代码;若所述被更新的代码为所述目标模块中被删除的代码,则从所述目标模块的接口文档中删除与所述处理后的接口信息相匹配的接口信息;若所述被更新的代码为所述目标模块中新增的代码,则将所述处理后的接口信息添加至所述目标模块的接口文档中;若所述被更新的代码为所述目标模块中被替换的代码,则从所述目标模块的接口文档中移出被替换前的代码对应的接口信息,并将所述处理后的接口信息添加至所述目标模块的接口文档中。

全文数据:一种接口文档更新方法、装置、电子设备及存储介质技术领域本发明涉及计算机技术领域,尤其涉及一种接口文档更新方法、装置、电子设备及存储介质。背景技术随着计算机技术的不断发展,软件系统的复杂度越来越高,代码量也越来越大,常用的软件系统动辄需要几十万,甚至上百万行的代码。因此,当软件系统的某一模块开发完成后,或者,模块被更新后,通常需要采用该模块的接口文档来生成测试用例,采用测试用例来验证该模块的功能是否满足需求。实践中发现,存在模块的更新速度与该模块的接口文档的更新速度不一致的问题,导致根据接口文档生成的测试用例的准确度不高,不能较准确地验证该模块的功能。发明内容本发明实施例提供一种接口文档更新方法、装置、电子设备及存储介质,可实时更新模块的接口文档,以便可以较准确验证该模块的功能。第一方面,本发明实施例提供了一种接口文档更新方法,该方法包括:根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,所述预设的规则包括根据模块的时间戳、版本号及代码行数中的至少一种设置的规则;获取所述目标模块中被更新的代码,及所述目标模块的接口文档,所述被更新的代码为所述目标模块中被删除的代码、新增的代码及被替换的代码中的至少一种;从所述被更新的代码对应的代码注释信息中提取接口信息,对提取到的接口信息进行格式处理,得到处理后的接口信息,所述代码注释信息用于解释所述被更新的代码;根据所述处理后的接口信息更新所述目标模块的接口文档,得到更新后的接口文档。第二方面,本发明实施例提供了一种接口文档更新装置,该装置包括:确定模块,用于根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,所述预设的规则包括根据模块的时间戳、版本号及代码行数中的至少一种设置的规则;获取模块,用于获取所述目标模块中被更新的代码,及所述目标模块的接口文档,所述被更新的代码为所述目标模块中被删除的代码、新增的代码及被替换的代码中的至少一种;提取模块,用于从所述被更新的代码对应的代码注释信息中提取接口信息;处理模块,用于对提取到的接口信息进行格式处理,得到处理后的接口信息,所述代码注释信息用于解释所述被更新的代码;更新模块,用于根据所述处理后的接口信息更新所述目标模块的接口文档,得到更新后的接口文档。第三方面,本发明实施例提供了一种电子设备,包括:处理器,适于实现一条或一条以上指令;以及,计算机可读存储介质,所述计算机可读存储介质存储有一条或一条以上指令,所述一条或一条以上指令适于由所述处理器加载并执行如步骤:确定模块,用于根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,所述预设的规则包括根据模块的时间戳、版本号及代码行数中的至少一种设置的规则;获取模块,用于获取所述目标模块中被更新的代码,及所述目标模块的接口文档,所述被更新的代码为所述目标模块中被删除的代码、新增的代码及被替换的代码中的至少一种;提取模块,用于从所述被更新的代码对应的代码注释信息中提取接口信息;处理模块,用于对提取到的接口信息进行格式处理,得到处理后的接口信息,所述代码注释信息用于解释所述被更新的代码;更新模块,用于根据所述处理后的接口信息更新所述目标模块的接口文档,得到更新后的接口文档。第四方面,本发明实施例提供了一种计算机可读存储介质,所述计算机可读存储介质存储有一条或一条以上指令,所述一条或一条以上指令适于由处理器加载并执行如下步骤:确定模块,用于根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,所述预设的规则包括根据模块的时间戳、版本号及代码行数中的至少一种设置的规则;获取模块,用于获取所述目标模块中被更新的代码,及所述目标模块的接口文档,所述被更新的代码为所述目标模块中被删除的代码、新增的代码及被替换的代码中的至少一种;提取模块,用于从所述被更新的代码对应的代码注释信息中提取接口信息;处理模块,用于对提取到的接口信息进行格式处理,得到处理后的接口信息,所述代码注释信息用于解释所述被更新的代码;更新模块,用于根据所述处理后的接口信息更新所述目标模块的接口文档,得到更新后的接口文档。本发明实施例中,电子设备通过模块的时间戳、版本号及代码行数等信息来检测代码数据库中的模块是否被更新,当存在模块被更新时,将被更新的模块确定为目标模块,这样可以自动获取更新的模块。并根据目标模块中被更新的代码对应的接口信息实时更新目标模块的接口文档,以便可以较准确验证该模块的功能,操作简单、便捷,提高对接口文档更新的效率。附图说明为了更清楚地说明本发明实施例技术方案,下面将对实施例描述中所需要使用的附图作简单地介绍,显而易见地,下面描述中的附图是本发明的一些实施例,对于本领域普通技术人员来讲,在不付出创造性劳动的前提下,还可以根据这些附图获得其他的附图。图1是本发明实施例提供的一种接口文档更新方法的流程示意图;图2是本发明实施例提供的另一种接口文档更新方法的流程示意图;图3是本发明实施例提供的一种接口文档更新装置的结构示意图;图4是本发明实施例提供的一种电子设备的结构示意图。具体实施方式下面将结合本发明实施例中的附图,对本发明实施例中的技术方案进行清楚、完整地描述,显然,所描述的实施例是本发明一部分实施例,而不是全部的实施例。基于本发明中的实施例,本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例,都属于本发明保护的范围。基于现有技术中,当一个应用程序被开发完成,并投入使用后,通常需要不断更新该应用程序中的一个或多个模块,以使该应用程序的性能更优、安全性更高等等。当应用程序的模块更新后,也需要同步更新该模块的接口文档,这样才能准确地基于接口文档来验证更新后的模块的功能是否满足需求。目前需要研发工程师手动更新模块的接口文档,存在研发工程师离职或忘记更新接口文档的情况,导致模块更新速度与该模块的接口文档的更新速度不一致,不能较准确的验证模块的功能是否满足需求,而且这种接口文档更新方法操作比较复杂、且费时、费力。基于当前接口文档更新方法中存在的问题,本发明实施例中提出一种接口文档更新方法,该方法可以由电子设备来执行,该电子设备可以是指智能终端、服务器或电脑等可用于存储的设备,该方法的具体实现过程包括:电子设备通过模块的时间戳、版本号及代码行数等信息来检测代码数据库中的模块是否被更新,当存在模块被更新时,将被更新的模块确定为目标模块,并获取目标模块中被更新的代码。从被更新的代码对应的代码注释信息中提取接口信息,根据提取的接口信息更新目标模块的接口文档。通过这样可以自动获取更新的模块,可实时更新模块的接口文档,以便可以较准确验证该模块的功能,操作简单、便捷,提高对接口文档更新的效率。请参见图1,是本发明实施例提供的一种接口文档更新方法的流程示意图,本发明实施例的所述方法可以由上述提及的电子设备来执行。本实施例中,该接口文档更新方法包括以下步骤。S101、根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,该预设的规则包括根据模块的时间戳、版本号及代码行数中的至少一种设置的规则。模块是指应用程序的一部分,具体的,模块可以是根据应用程序的功能划分得到的,如该应用程序为即时通信程序,该模块可以为用户账号信息管理模块、信息收发处理模块及界面展示模块等等。代码数据库是指用于存储应用程序的数据库,代码数据库中可以包括一个或多个模块。为了同步更新模块的接口文档,电子设备可以根据预设的规则检测代码数据库中的模块是否被更新,若检测到被更新的模块,则确定被更新的模块为目标模块。这样可自动检测出被更新的模块,并且效率较高,不需要将代码数据库中每个模块中的历史代码与当前代码进行比较,此处被更新的模块是指模块中的代码被更新的模块。在一个实施例中,为了降低电子设备的资源消耗,电子设备可以基于预设时间间隔根据预设的规则检测代码数据库是否存在代码被更新的模块,将代码被更新的模块确定为目标模块。预设时间间隔可以是根据代码数据库中每个模块历史被更新的速度确定的,模块的历史被更新的速度是指预设时间段内的平均更新速度或最大更新速度等等。例如,如在一周之内模块被更新4次,每相邻两次的更新时间间隔分别为1天、1天及2天,则该模块被更新的速度包括每1天一次,每2天一次,电子设备可以将预设时间间隔设置为1天即24小时,电子设备可以每隔24小时采用预设的规则检测代码数据库是否存在代码被更新的模块。在另一个实施例中,为了降低电子设备的资源消耗,电子设备可以在对模块进行测试时,才检测该模块的代码是否被更新。具体的,若接收关于对某一模块的测试指令,根据预设的规则检测该模块的代码是否被更新,若该模块的代码被更新,则将该模块确定为目标模块。在又一个实施例中,电子设备可以实时地根据预设的规则检测代码数据库中的至少一个模块中是否存在代码被更新的模块,若存在,则将代码被更新的模块确定为目标模块。S102、获取该目标模块中被更新的代码,及该目标模块的接口文档,该被更新的代码为该目标模块中被删除的代码、新增的代码及被替换的代码中的至少一种。当确定目标模块被更新后,电子设备可以获取该目标模块中被更新的代码,其中,被更新的代码为一行代码或多行代码即代码段,具体的,电子设备可以根据开发该目标模块的设备的系统日志信息获取该目标模块被更新的代码,系统日志是指记录系统中所发生的事件,具体可包括事件发生的时间及操作过程等等。或者,电子设备可以根据该目标模块的历史代码获取该目标模块被更新的代码,历史代码为该目标模块最近一个被更新时的代码。进一步,电子设备可以获取该目标模块的接口文档,目标模块的接口文档是用于记录该目标模块的接口信息的文档,接口信息可以包括接口名称、接口统一资源定位符、接口说明、输入参数、输出参数、返回数据、接口测试服务器的域名及端口中的一种或多种。在一个实施例中,电子设备可以获取开发该目标模块的设备的系统日志数据,根据该目标模块的标识从该系统日志数据中提取关于该目标模块的日志数据。目标模块的标识可以是指目标模块的名称和存储该目标模块的地址信息等等;该目标模块的日志数据记录了对目标模块的操作事件,从该目标模块的日志数据获取该目标模块中更新的代码。其中,开发该目标模块的设备与该电子设备可以是指同一个设备,也可以是不同设备。在一个实施例中,由为了便于后续查看目标模块的开发过程,电子设备中通常记录了目标模块的历史代码,此处若该目标模块被更新过,则该历史代码是指最近一次更新后该目标模块的代码;若该目标模块未被更新过,则该历史代码是指该目标模块被开发完成时的代码即原始代码。电子设备可以获取该目标模块的历史代码,将历史代码与该目标模块中当前的代码进行比较,以得到更新后的代码。S103、从该被更新的代码对应的代码注释信息中提取接口信息,对提取到的接口信息进行格式处理,得到处理后的接口信息,该代码注释信息用于解释该被更新的代码。为了同步更新目标模块的接口文档,电子设备可以从该被更新的代码对应的代码注释信息中提取接口信息,具体的,电子设备可以从该被更新的代码对应的代码注释信息中提取携带预设标识的注释信息,根据预设标识的注释信息生成接口信息,预设标识可以包括目标函数标识,输入参数标识及输出标识。为了便于后续对接口文档的编写、修改开发等或快捷地生成测试用,电子设备可以按照预设格式对提取的接口信息进行格式处理,得到处理后的接口信息,上述预设格式可以根据实际需要设置,例如预设格式可以是根据目标模块的代码类型设置的,预设格式可以是该目标模块中的接口文档中接口信息的格式。在一个实施例中,为了便于用户理解模块中的代码,通常开发人员在代码的编写过程中会在代码段上同步添加对应的代码注解信息,并在这些代码注解信息中使用预设标识分别标识代码的概要信息及参数信息等内容。其中,概要信息包括对接口名称、接口统一资源定位符、接口说明、返回数据、接口测试服务器的域名及端口的解释说明。参数信息包括对输入参数和输出参数的解释说明。因此,电子设备可以从该被更新的代码对应的代码注释信息中提取携带预设标识的注释信息,根据预设标识的注释信息生成接口信息。例如,输入参数标识可以为@PAFInput,输出参数标识可以为@PAFOutput,从被更新的代码对应的代码注释信息提取携带@PAFInput的注释信息,及携带@PAFOutput的注释信息。如携带@PAFInput的注释信息为@PAFInputdesc=“”,即@PAFInputdesc=“”中双引号内的信息为输入参数。携带@PAFOutput的注释信息为@PAFOutputdesc=“”,即@PAFOutputdesc=“”中双引号内的信息为输出参数。S104、根据该处理后的接口信息更新该目标模块的接口文档,得到更新后的接口文档。电子设备可以根据该处理后的接口信息更新该目标模块的接口文档,得到更新后的接口文档。在一个实施例中,若该被更新的代码为该目标模块中被删除的代码,则从该目标模块的接口文档中删除与该处理后的接口信息相匹配的接口信息;若该被更新的代码为该目标模块中新增的代码,则将该处理后的接口信息添加至该目标模块的接口文档中;若该被更新的代码为该目标模块中被替换的代码,则从该目标模块的接口文档中移出被替换前的代码对应的接口信息,并将该处理后的接口信息添加至该目标模块的接口文档中。若该被更新的代码为该目标模块中被删除的代码,则被删除的代码不会影响该目标模块的功能,即表明该被删除的代码对应的接口信息为无效的接口信息,不能用于测试该目标模块的功能,因此,从该目标模块的接口文档中删除与该处理后的接口信息相匹配的接口信息。举例来说,接口文档中记录了目标模块中的接口信息的来源,即每项接口信息是从哪一行代码的代码注释信息中获取的。该被删除的代码为目标模块中的原代码的第112-150行代码,则从该目标模块的接口文档中删除来源于目标模块的原代码的第112-150的注释信息中的接口信息。若该被更新的代码为该目标模块中新增的代码,则表明新增的代码会影响该目标模块的功能,即该新增的代码对应的接口信息为有用接口信息,因此,可以将该处理后的接口信息添加至该目标模块的接口文档中。例如,该新增的代码对应的接口信息为输入参数及输出参数,则电子设备可以将该新增的代码对应的接口信息添加至该目标模块的接口文档中存储参数的位置。若该被更新的代码为该目标模块中被替换的代码即被替换后的代码,则该被替换的代码替换了该目标模块中替换前的代码对应的功能,即需要根据被替换的代码的接口信息来验证该目标模块当前的功能,因此,可以从该目标模块的接口文档中移出被替换前的代码对应的接口信息,并将该处理后的接口信息添加至该目标模块的接口文档中。例如,假设该被替换的代码替换了目标模块中第112-150行代码,则电子设备可以采用被替换的代码对应的接口信息替换目标模块的接口文档中第112-150行代码对应的接口信息。本发明实施例中,电子设备通过模块的时间戳、版本号及代码行数等信息来检测代码数据库中的模块是否被更新,当存在模块被更新时,将被更新的模块确定为目标模块,这样可以自动获取更新的模块。并获取目标模块中被更新的代码,从被更新的代码对应的代码注释信息中提取接口信息,并对提取的接口信息进行格式处理,得到处理后的接口信息,根据处理的接口信息更新目标模块的接口文档。根据目标模块中被更新的代码对应的接口信息实时更新目标模块的接口文档,以便可以较准确验证该模块的功能,操作简单、便捷,提高对接口文档更新的效率。另外,通过对提取的接口信息进行格式处理,有利于后续对接口文档的编写、修改开发。请参见图2,是本发明实施例提供的另一种接口文档更新方法的流程示意图,本发明实施例的所述方法可以由上述提及的电子设备来执行。本实施例中,该接口文档更新方法包括以下步骤。S201、根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,该预设的规则包括根据模块的时间戳、版本号及代码行数中的至少一种设置的规则。在一个实施例中,该预设的规则包括根据模块的时间戳设置的规则,步骤S201具体可包括如下步骤s11~s12。s11、获取该代码数据库中每个模块上一次更新的第一时间戳,及每个该模块对应的接口文档上一次更新的第二时间戳。s12、将该代码数据库中该第一时间戳与该第二时间戳之间的差值大于预设阈值的模块确定为目标模块。在步骤s11~s12中,电子设备可以获取该代码数据库中每个模块上一次更新的第一时间戳,及每个该模块对应的接口文档上一次更新的第二时间戳。具体的,若该模块未被更新过,则该模块上一个更新的第一时间戳可以是指该模块被开发完成的时间戳,该模块对应的接口文档上一次更新的第二时间戳可以是指该模块的接口文档被建立的时间戳。若该模块被更新过,则该模块上一个更新的第一时间戳可以是指该模块最近一次被更新的时间戳,该模块对应的接口文档上一次更新的第二时间戳可以是指最近一次被更新的时间戳。其中,时间戳具体可以是指时间,或者用于标识时间的字符等等,相同时间对应的时间戳通常相同。进一步,若该代码数据库中某一模块的该第一时间戳与该第二时间戳之间的差值大于预设阈值,则表明该模块的接口文档的更新时间未与该模块的更新时间同步,电子设备可以将第一时间戳与该第二时间戳之间的差值大于预设阈值的模块确定为目标模块,其中,该预设阈值可以是用户手动设置的,或是根据模块中代码的更新速度确定的,例如,该预设阈值可以小于该模块中的代码的最小更新速度。可选的,若该代码数据库中模块对应的第二时间戳指示的时间早于第一时间戳指示的时间,则确定该模块更新后,未更新该模块的接口文档,因此可以将该模块作为目标模块。举例来说,假设预设阈值为2天,该代码数据库中包括模块1,若模块1的代码最近被更新的第一时间戳为2018年8月15日,模块1对应的接口文档的最近被更新的第二时间戳为2018年8月11日,第一时间戳与第二时间戳的差值为4天,即模块1对应的第一时间戳与第二时间戳之间的差值大于预设阈值,则确定模块1为目标模块。在另一个实施例中,该预设的规则包括根据模块的版本号设置的规则,步骤S201具体可包括如下步骤s21~s22。s21、获取该代码数据库中每个模块当前的版本号及历史版本号,每个该模块的历史版本号为上一次更新对应模块的接口文档时该模块的版本号。s22、将该代码数据库中当前的版本号与该历史版本号不相同的模块确定为目标模块。在步骤s21~s22中,通常模块被更新后,被更新的模块会被赋予一个新的版本号,因此,可以根据模块的版本号来判断该模块是否被更新。具体的,电子设备可以获取该代码数据库中每个模块当前的版本号及历史版本号,若该代码数据库中某一模块当前的版本号与该历史版本号不相同,则表明该模块被更新,可以将该代码数据库中当前的版本号与该历史版本号不相同的模块确定为目标模块。例如,该代码数据库中包括模块1,该模块1的历史版本号为最近一次更新对应模块1的接口文档时该模块1的版本号。若模块1的历史版本号为1.1.2,该模块当前的版本号为1.1.3,则确定模块1的当前版本号与历史版本号不相同,确定模块1的代码被更新,即将该模块1作为目标模块。在又一个实施例中,该预设的规则包括根据模块的代码行数设置的规则,步骤S201具体可包括如下步骤s31~s32。s31、获取该代码数据库中每个模块当前的代码行数及历史代码行数,每个模块的历史代码行数为上一次更新对应模块的接口文档时对应模块的代码行数。s32、将该代码数据库中当前的代码行数与该历史代码行数不相同的模块确定为目标模块。在步骤s31~s32中,当模块中被新增代码或被删除代码,则该模块的代码行数会发生变化,因此,电子设备可以根据模块的代码行数来判断模块是否被更新。具体的,电子设备可以获取该代码数据库中每个模块当前的代码行数及历史代码行数,若模块当前的代码行数与该历史代码行数不相同,则表明模块中被新增了代码或被删除了代码,可将该代码数据库中当前的代码行数与该历史代码行数不相同的模块确定为目标模块。例如,该代码数据库中包括模块1,该模块1的历史行数为最近一次更新对应模块1的接口文档时该模块1的代码行数。若模块1的历史代码行数为1千行,该模块当前的代码行数为2千行,则确定模块1的当前代码行数与历史代码行数不相同,确定模块1的代码被更新,即将该模块1作为目标模块。S202、获取该目标模块中被更新的代码,及该目标模块的接口文档,该被更新的代码为该目标模块中被删除的代码、新增的代码及被替换的代码中的至少一种。S203、从该被更新的代码对应的代码注释信息中提取接口信息,对提取到的接口信息进行格式处理,得到处理后的接口信息,该代码注释信息用于解释该被更新的代码。在一个实施例中,步骤S203具体可以包括如下步骤s41~s43。s41、获取该目标模块中的代码类型。s42、根据该目标模块中的代码类型确定用于测试该目标模块的测试用例的格式。s43、根据该测试用例的格式对提取到的接口信息进行处理,得到处理后的接口信息。在步骤s41~s43中,为了便于后续对接口文档的编写、修改开发等或快捷地生成测试用,电子设备可以获取该目标模块的代码类型,代码类型可以包括C语言、面向对象且直译式计算机程序设计语言Python或面向对象的程序设计语言Java等等。每种类型的代码对应的测试用例的格式不一致,因此,可以根据该目标模块中的代码类型确定用于测试该目标模块的测试用例的格式,为了在对目标模块测试时,可快速地将该目标模块的接口文档添加至测试用例中,电子设备可以根据该测试用例的格式对提取到的接口信息进行处理,得到处理后的接口信息。例如,该目标模块的代码类型为Java,则该目标模块对应的测试用例的格式可以为对象简谱JavaScriptObjectNotation,JSON,即一种轻量级的数据交换格式,根据JSON格式对提取到的接口信息进行处理,得到处理后的接口信息。S204、根据该处理后的接口信息更新该目标模块的接口文档,得到更新后的接口文档。S205、接收针对该目标模块的测试请求。S206、将该更新后的接口文档中的接口信息添加至用于测试该目标模块的测试用例中,该更新后的接口文档中的接口信息包括以下的一项或多项:接口名称、接口统一资源定位符、接口说明、输入参数、输出参数、返回数据、接口测试服务器的域名及端口。S207、根据该目标模块的测试用例对该目标模块进行测试。在步骤S205~S207中,当接收到针对目标模块的测试请求,电子设备可以将该更新后的接口文档中的接口信息添加至用于测试该目标模块的测试用例中,并根据该目标模块的测试用例对该目标模块进行测试,该更新后的接口文档为该目标模块的最新接口文档,因此,可较准确地测试该目标模块的功能是否满足需求。本发明实施例中,电子设备通过模块的时间戳、版本号及代码行数等信息来检测代码数据库中的模块是否被更新,当存在模块被更新时,将被更新的模块确定为目标模块,这样可以自动获取更新的模块。并获取目标模块中被更新的代码,从被更新的代码对应的代码注释信息中提取接口信息,并对提取的接口信息进行格式处理,得到处理后的接口信息,根据处理的接口信息更新目标模块的接口文档。根据目标模块中被更新的代码对应的接口信息实时更新目标模块的接口文档,以便可以较准确验证该模块的功能,操作简单、便捷,提高对接口文档更新的效率。另外,对提取的接口信息进行格式处理,以便于后续对接口文档的编写、修改开发。请参见图3,是本发明实施例提供的一种接口文档更新装置的结构示意图,本发明实施例的所述装置可以设置在上述提及的电子设备中。本实施例中,该接口文档更新装置包括:确定模块301,用于根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,所述预设的规则包括根据模块的时间戳、版本号及代码行数中的至少一种设置的规则;获取模块302,用于获取所述目标模块中被更新的代码,及所述目标模块的接口文档,所述被更新的代码为所述目标模块中被删除的代码、新增的代码及被替换的代码中的至少一种;提取模块303,用于从所述被更新的代码对应的代码注释信息中提取接口信息;处理模块304,用于对提取到的接口信息进行格式处理,得到处理后的接口信息,所述代码注释信息用于解释所述被更新的代码;更新模块305,用于根据所述处理后的接口信息更新所述目标模块的接口文档,得到更新后的接口文档。可选的,所述预设的规则包括根据模块的时间戳设置的规则,确定模块301,具体用于获取所述代码数据库中每个模块上一次更新的第一时间戳,及每个所述模块对应的接口文档上一次更新的第二时间戳;将所述代码数据库中所述第一时间戳与所述第二时间戳之间的差值大于预设阈值的模块确定为目标模块。可选的,所述预设的规则包括根据模块的版本号设置的规则,确定模块301,具体用于获取所述代码数据库中每个模块当前的版本号及历史版本号,每个所述模块的历史版本号为上一次更新对应模块的接口文档时所述模块的版本号;将所述代码数据库中当前的版本号与所述历史版本号不相同的模块确定为目标模块。可选的,所述预设的规则包括根据模块的代码行数设置的规则,确定模块301,具体用于获取所述代码数据库中每个模块当前的代码行数及历史代码行数,每个模块的历史代码行数为上一次更新对应模块的接口文档时对应模块的代码行数;将所述代码数据库中当前的代码行数与所述历史代码行数不相同的模块确定为目标模块。可选的,提取模块303,具体用于获取所述目标模块中的代码类型;根据所述目标模块中的代码类型确定用于测试所述目标模块的测试用例的格式;根据所述测试用例的格式对提取到的接口信息进行处理,得到处理后的接口信息。可选的,更新模块305,用于若所述被更新的代码为所述目标模块中被删除的代码,则从所述目标模块的接口文档中删除与所述处理后的接口信息相匹配的接口信息;若所述被更新的代码为所述目标模块中新增的代码,则将所述处理后的接口信息添加至所述目标模块的接口文档中;若所述被更新的代码为所述目标模块中被替换的代码,则从所述目标模块的接口文档中移出被替换前的代码对应的接口信息,并将所述处理后的接口信息添加至所述目标模块的接口文档中。可选的,所述装置还包括:测试模块306,用于接收针对所述目标模块的测试请求;将所述更新后的接口文档中的接口信息添加至用于测试所述目标模块的测试用例中,所述更新后的接口文档中的接口信息包括以下的一项或多项:接口名称、接口统一资源定位符、接口说明、输入参数、输出参数、返回数据、接口测试服务器的域名及端口;根据所述目标模块的测试用例对所述目标模块进行测试。本发明实施例中,电子设备通过模块的时间戳、版本号及代码行数等信息来检测代码数据库中的模块是否被更新,当存在模块被更新时,将被更新的模块确定为目标模块,这样可以自动获取更新的模块。并获取目标模块中被更新的代码,从被更新的代码对应的代码注释信息中提取接口信息,并对提取的接口信息进行格式处理,得到处理后的接口信息,根据处理的接口信息更新目标模块的接口文档。根据目标模块中被更新的代码对应的接口信息实时更新目标模块的接口文档,以便可以较准确验证该模块的功能,操作简单、便捷,提高对接口文档更新的效率。另外,对提取的接口信息对进行格式处理,以便于后续对接口文档的编写、修改开发。请参见图4,是本发明实施例提供的一种电子设备的结构示意图,如图所示的本实施例中的电子设备可以包括:一个或多个处理器401;一个或多个输入装置402,一个或多个输出装置403和存储器404。上述处理器401、输入装置402、输出装置403和存储器404通过总线405连接。所处理器401可以是中央处理单元CentralProcessingUnit,CPU,该处理器还可以是其他通用处理器、数字信号处理器DigitalSignalProcessor,DSP、专用集成电路ApplicationSpecificIntegratedCircuit,ASIC、现成可编程门阵列Field-ProgrammableGateArray,FPGA或者其他可编程逻辑器件、分立门或者晶体管逻辑器件、分立硬件组件等。通用处理器可以是微处理器或者该处理器也可以是任何常规的处理器等。输入装置402可以包括触控板、指纹采传感器用于采集用户的指纹信息和指纹的方向信息、麦克风等,输出装置403可以包括显示器LCD等、扬声器等,输出装置403可以输出提示信息,提示信息可用于提示目标用户是否存在异常住院行为。该存储器404可以包括只读存储器和随机存取存储器,并向处理器401提供指令和数据。存储器404的一部分还可以包括非易失性随机存取存储器,存储器404用于存储计算机程序,所述计算机程序包括程序指令,处理器401用于执行存储器404存储的程序指令,以用于执行一种接口文档更新方法,即用于执行以下操作:根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,所述预设的规则包括根据模块的时间戳、版本号及代码行数中的至少一种设置的规则;获取所述目标模块中被更新的代码,及所述目标模块的接口文档,所述被更新的代码为所述目标模块中被删除的代码、新增的代码及被替换的代码中的至少一种;从所述被更新的代码对应的代码注释信息中提取接口信息,对提取到的接口信息进行格式处理,得到处理后的接口信息,所述代码注释信息用于解释所述被更新的代码;根据所述处理后的接口信息更新所述目标模块的接口文档,得到更新后的接口文档。可选的,所述预设的规则包括根据模块的时间戳设置的规则,处理器用于执行存储器存储的程序指令,用于执行以下操作:获取所述代码数据库中每个模块上一次更新的第一时间戳,及每个所述模块对应的接口文档上一次更新的第二时间戳;将所述代码数据库中所述第一时间戳与所述第二时间戳之间的差值大于预设阈值的模块确定为目标模块。可选的,所述预设的规则包括根据模块的版本号设置的规则,处理器用于执行存储器存储的程序指令,用于执行以下操作:获取所述代码数据库中每个模块当前的版本号及历史版本号,每个所述模块的历史版本号为上一次更新对应模块的接口文档时所述模块的版本号;将所述代码数据库中当前的版本号与所述历史版本号不相同的模块确定为目标模块。可选的,所述预设的规则包括根据模块的代码行数设置的规则,处理器用于执行存储器存储的程序指令,用于执行以下操作:获取所述代码数据库中每个模块当前的代码行数及历史代码行数,每个模块的历史代码行数为上一次更新对应模块的接口文档时对应模块的代码行数;将所述代码数据库中当前的代码行数与所述历史代码行数不相同的模块确定为目标模块。可选的,处理器用于执行存储器存储的程序指令,用于执行以下操作:获取所述目标模块中的代码类型;根据所述目标模块中的代码类型确定用于测试所述目标模块的测试用例的格式;根据所述测试用例的格式对提取到的接口信息进行处理,得到处理后的接口信息。可选的,处理器用于执行存储器存储的程序指令,用于执行以下操作:若所述被更新的代码为所述目标模块中被删除的代码,则从所述目标模块的接口文档中删除与所述处理后的接口信息相匹配的接口信息;若所述被更新的代码为所述目标模块中新增的代码,则将所述处理后的接口信息添加至所述目标模块的接口文档中;若所述被更新的代码为所述目标模块中被替换的代码,则从所述目标模块的接口文档中移出被替换前的代码对应的接口信息,并将所述处理后的接口信息添加至所述目标模块的接口文档中。可选的,处理器用于执行存储器存储的程序指令,用于执行以下操作:接收针对所述目标模块的测试请求;将所述更新后的接口文档中的接口信息添加至用于测试所述目标模块的测试用例中,所述更新后的接口文档中的接口信息包括以下的一项或多项:接口名称、接口统一资源定位符、接口说明、输入参数、输出参数、返回数据、接口测试服务器的域名及端口;根据所述目标模块的测试用例对所述目标模块进行测试。本发明实施例中,电子设备通过模块的时间戳、版本号及代码行数等信息来检测代码数据库中的模块是否被更新,当存在模块被更新时,将被更新的模块确定为目标模块,这样可以自动获取更新的模块。并获取目标模块中被更新的代码,从被更新的代码对应的代码注释信息中提取接口信息,并对提取的接口信息进行格式处理,得到处理后的接口信息,根据处理的接口信息更新目标模块的接口文档。根据目标模块中被更新的代码对应的接口信息实时更新目标模块的接口文档,以便可以较准确验证该模块的功能,操作简单、便捷,提高对接口文档更新的效率。另外,对提取的接口信息进行格式处理,以便于后续对接口文档的编写、修改开发。本发明实施例中所描述的处理器401、输入装置402、输出装置403可执行本发明实施例提供的接口文档更新方法的第一实施例和第二实施例中所描述的实现方式,也可执行本发明实施例所描述的电子设备的实现方式,在此不再赘述。在本发明的另一实施例中提供一种计算机可读存储介质,所述计算机可读存储介质存储有计算机程序,所述计算机程序包括程序指令,所述程序指令被处理器执行时实现本发明的图1及图2实施例中所示的接口文档更新方法。所述计算机可读存储介质可以是前述任一实施例所述的电子设备的内部存储单元,例如控制设备的硬盘或内存。所述计算机可读存储介质也可以是所述控制设备的外部存储设备,例如所述控制设备上配备的插接式硬盘,智能存储卡SmartMediaCard,SMC,安全数字SecureDigital,SD卡,闪存卡FlashCard等。进一步地,所述计算机可读存储介质还可以既包括所述控制设备的内部存储单元也包括外部存储设备。所述计算机可读存储介质用于存储所述计算机程序以及所述控制设备所需的其他程序和数据。所述计算机可读存储介质还可以用于暂时地存储已经输出或者将要输出的数据。本领域普通技术人员可以意识到,结合本文中所公开的实施例描述的各示例的单元及算法步骤,能够以电子硬件、计算机软件或者二者的结合来实现,为了清楚地说明硬件和软件的可互换性,在上述说明中已经按照功能一般性地描述了各示例的组成及步骤。这些功能究竟以硬件还是软件方式来执行,取决于技术方案的特定应用和设计约束条件。专业技术人员可以对每个特定的应用来使用不同方法来实现所描述的功能,但是这种实现不应认为超出本发明的范围。所属领域的技术人员可以清楚地了解到,为了描述的方便和简洁,上述描述的控制设备和单元的具体工作过程,可以参考前述方法实施例中的对应过程,在此不再赘述。在本申请所提供的几个实施例中,应该理解到,所揭露的控制设备和方法,可以通过其它的方式实现。例如,以上所描述的装置实施例仅仅是示意性的,例如,所述单元的划分,仅仅为一种逻辑功能划分,实际实现时可以有另外的划分方式,例如多个单元或组件可以结合或者可以集成到另一个系统,或一些特征可以忽略,或不执行。以上所述仅为本发明的具体实施方式,但本发明的保护范围并不局限于此,任何熟悉本技术领域的技术人员在本发明揭露的技术范围内,可轻易想到各种等效的修改或替换,这些修改或替换都应涵盖在本发明的保护范围之内。因此,本发明的保护范围应以权利要求的保护范围为准。

权利要求:1.一种接口文档更新方法,其特征在于,包括:根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,所述预设的规则包括根据模块的时间戳、版本号及代码行数中的至少一种设置的规则;获取所述目标模块中被更新的代码,及所述目标模块的接口文档,所述被更新的代码为所述目标模块中被删除的代码、新增的代码及被替换的代码中的至少一种;从所述被更新的代码对应的代码注释信息中提取接口信息,对提取到的接口信息进行格式处理,得到处理后的接口信息,所述代码注释信息用于解释所述被更新的代码;根据所述处理后的接口信息更新所述目标模块的接口文档,得到更新后的接口文档。2.根据权利要求1所述的方法,其特征在于,所述预设的规则包括根据模块的时间戳设置的规则,所述根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,包括:获取所述代码数据库中每个模块上一次更新的第一时间戳,及每个所述模块对应的接口文档上一次更新的第二时间戳;将所述代码数据库中所述第一时间戳与所述第二时间戳之间的差值大于预设阈值的模块确定为目标模块。3.根据权利要求1所述的方法,其特征在于,所述预设的规则包括根据模块的版本号设置的规则,所述根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,包括:获取所述代码数据库中每个模块当前的版本号及历史版本号,每个所述模块的历史版本号为上一次更新对应模块的接口文档时对应模块的版本号;将所述代码数据库中当前的版本号与所述历史版本号不相同的模块确定为目标模块。4.根据权利要求1所述的方法,其特征在于,所述预设的规则包括根据模块的代码行数设置的规则,所述根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,包括:获取所述代码数据库中每个模块当前的代码行数及历史代码行数,每个模块的历史代码行数为上一次更新对应模块的接口文档时对应模块的代码行数;将所述代码数据库中当前的代码行数与所述历史代码行数不相同的模块确定为目标模块。5.根据权利要求1所述的方法,其特征在于,所述对提取到的接口信息进行格式处理,得到处理后的接口信息,包括:获取所述目标模块中的代码类型;根据所述目标模块中的代码类型确定用于测试所述目标模块的测试用例的格式;根据所述测试用例的格式对提取到的接口信息进行处理,得到处理后的接口信息。6.根据权利要求1所述的方法,其特征在于,所述根据所述处理后的接口信息更新所述目标模块的接口文档,得到更新后的接口文档,包括:若所述被更新的代码为所述目标模块中被删除的代码,则从所述目标模块的接口文档中删除与所述处理后的接口信息相匹配的接口信息;若所述被更新的代码为所述目标模块中新增的代码,则将所述处理后的接口信息添加至所述目标模块的接口文档中;若所述被更新的代码为所述目标模块中被替换的代码,则从所述目标模块的接口文档中移出被替换前的代码对应的接口信息,并将所述处理后的接口信息添加至所述目标模块的接口文档中。7.根据权利要求1-6任一项所述的方法,其特征在于,所述方法还包括:接收针对所述目标模块的测试请求;将所述更新后的接口文档中的接口信息添加至用于测试所述目标模块的测试用例中,所述更新后的接口文档中的接口信息包括以下的一项或多项:接口名称、接口统一资源定位符、接口说明、输入参数、输出参数、返回数据、接口测试服务器的域名及端口;根据所述目标模块的测试用例对所述目标模块进行测试。8.一种接口文档更新装置,其特征在于,包括:确定模块,用于根据预设的规则从代码数据库中的至少一个模块中确定出代码被更新的目标模块,所述预设的规则包括根据模块的时间戳、版本号及代码行数中的至少一种设置的规则;获取模块,用于获取所述目标模块中被更新的代码,及所述目标模块的接口文档,所述被更新的代码为所述目标模块中被删除的代码、新增的代码及被替换的代码中的至少一种;提取模块,用于从所述被更新的代码对应的代码注释信息中提取接口信息;处理模块,用于对提取到的接口信息进行格式处理,得到处理后的接口信息,所述代码注释信息用于解释所述被更新的代码;更新模块,用于根据所述处理后的接口信息更新所述目标模块的接口文档,得到更新后的接口文档。9.一种电子设备,其特征在于,包括:处理器,适于实现一条或一条以上指令;以及,可读计算机存储介质,所述可读计算机存储介质存储有一条或一条以上指令,所述一条或一条以上指令适于由处理器加载并执行如权利要求1-7任一项所述的接口文档更新方法。10.一种可读计算机存储介质,其特征在于,所述可读计算机存储介质存储有一条或一条以上指令,所述一条或一条以上指令适于由处理器加载并执行如权利要求1-7任一项所述的接口文档更新方法。

百度查询: 平安科技(深圳)有限公司 一种接口文档更新方法、装置、电子设备及存储介质

免责声明
1、本报告根据公开、合法渠道获得相关数据和信息,力求客观、公正,但并不保证数据的最终完整性和准确性。
2、报告中的分析和结论仅反映本公司于发布本报告当日的职业理解,仅供参考使用,不能作为本公司承担任何法律责任的依据或者凭证。