一种开发文档的自动化录入方法及装置

技术领域

本方法属于开发文档的数据管理领域，尤其涉及一种开发文档的自动化录入方法及装置。

背景技术

现在基本上所有的软件开发公司都会要求将开发的接口(源代码文件)进行统一的文档管理，以方便测试人员和对接人员进行查看。例如某些公司会使用rap系统或yapi系统来统一存储和管理文档，但是因为数据结构不适配，所以现有的开发文档都是手动录入rap系统或yapi系统上。由于是人工手动录入的，繁琐复杂麻烦又容易出错，而且一般接口数量非常多，可能一个项目的数据录入将花费1个钟甚至几个钟，这个是巨大的时间代价。

发明内容

鉴于以上所述现有技术的缺点，本发明的目的在于提供一种能够高效、低失误地将开发文档自动录入到文档系统中的方法。

本申请方案提供一种开发文档的自动化录入方法，包括：

响应于被触发的目标程序，接收任务信息；

根据所述任务信息，查找并配置对应的生成配置信息及录入配置信息；

根据所述生成配置信息，获取所述开发文档的接口数据；

根据所述录入配置信息，登录对应的目标文档系统；

将所述接口数据转换为请求数据，所述请求数据的数据结构被配置为与所述目标文档系统适配；

将所述请求数据录入到所述目标文档系统中。

进一步地，所述生成配置信息包括项目路径和包路径，所述包路径是所述项目路径下的相对路径，所述开发文档位于所述包路径下。

进一步地，所述录入配置信息包括目标文档系统名称、目标文档系统的鉴权信息、目标文档系统的服务器地址。

进一步地，所述的根据所述生成配置信息，获取开发文档的接口数据，包括：根据所述生成配置信息定位所述开发文档，然后利用JAVA的反射读取所述开发文档，最后通过解析所述开发文档上的参数信息获得所述接口数据。

还提供一种开发文档的自动化录入装置，包括：

任务配置模块，响应于目标程序的被触发，接收任务信息，然后根据所述任务信息查找并配置对应的生成配置信息及录入配置信息；

接口数据获取模块，根据所述生成配置信息，获取开发文档的接口数据；

请求调用模块，根据所述录入配置信息，登录对应的目标文档系统；

数据转换模块，将所述接口数据转换为请求数据，所述请求数据的数据结构被配置为与所述目标文档系统适配；

数据录入模块，将所述请求数据录入到所述目标文档系统中。

进一步地，所述接口数据获取模块被配置为：根据所述生成配置信息定位所述开发文档，然后利用JAVA的反射读取所述开发文档，最后通过解析所述开发文档上的参数信息获得所述接口数据。

本申请的改进带来如下优点：本申请提供的开发文档的自动化录入方法及装置，可以快速、高效率、低失误地将开发文档录入到目标文档系统中。相比人工录入来说，录入的效率和质量均有质的提升。人工录入可能需时几个小时，而采用本申请的方法只需几分钟甚至几十秒。

附图说明

图1为本申请实施例提供的实现开发文档自动化录入的一种可选系统架构。

图2为本申请实施例自动化录入方法的步骤流程示意图。

图3为本申请实施例自动化录入方法的结构流程示意图。

图4为本申请实施例中某一项目的接口数据的数据结构。

图5为本申请实施例中某一项目对应的目标文档系统的数据结构。

具体实施方式

以下通过特定的具体实例说明本发明的实施方式，本领域技术人员可由本说明书所揭露的内容轻易地了解本发明的其他优点与功效。本发明还可以通过另外不同的具体实施方式加以实施或应用，本说明书中的各项细节也可以基于不同观点与应用，在没有背离本发明的精神下进行各种修饰或改变。

图1为本申请实施例提供的实现开发文档自动化录入的一种可选系统架构，如图1所示，该系统架构可以包括：项目文件100、目标程序200以及目标文档系统300。

其中，项目文件100可以存储于某个本地或云端服务器或数据库中，其中包含有该项目的源代码文件，即开发文档。目标程序200是实现开发文档自动化录入的主要程序，其可以访问项目文件和登录目标文档系统，并有权限向目标文档系统中写入数据。目标文档系统300可以为数据录入的目的方，以保存和供具有查看权限的人员查看开发文档信息，可以是云端系统。

本申请要实现的是：根据任务信息，查找并配置对应的生成配置信息及录入配置信息，然后分别获取开发文档的接口数据以及目标文档系统的接口信息；接着登录目标文档系统以及将开发文档的接口数据转换为请求数据；最后将请求数据录入到目标文档系统中。

接下来，以目标程序的角度，对本申请的开发文档自动化录入方法进行介绍，如图2、3所示，图2示出了本申请实施例提供的开发文档自动化录入方法流程图，图3为本申请实施例提供的开发文档自动化录入方法的结构流程示意图，该方法可以包括以下步骤：

S100，响应于目标程序的被触发，接收任务信息。

S200，根据任务信息，查找并配置对应的生成配置信息及录入配置信息。

具体的，生成配置信息可以包括项目路径和包路径，项目路径即上述项目文件的存储路径，包路径是项目路径下的相对路径，开发文档位于包路径下。

S300，根据生成配置信息，获取开发文档的接口数据。

具体的，根据生成配置信息定位开发文档，然后利用JAVA的反射读取开发文档，最后通过解析开发文档上的参数信息获得所述接口数据。

S400，根据录入配置信息，登录对应的目标文档系统。

具体的，录入配置信息可以包括目标文档系统名称、目标文档系统的鉴权信息、目标文档系统的服务器地址或目标文档系统的模块名称。目标程序通过目标文档系统的服务器地址请求调用目标文档系统，并通过目标文档系统登录用的cookie等鉴权信息登录目标文档系统，并根据模块名称寻找到对应要录入的模块。

S500，将接口数据转换为请求数据，请求数据的数据结构被配置为与目标文档系统适配。

某一物联网项目下的接口数据的数据结构可以如图4所示，而目标文档系统(可以为rap文档系统)上对应的数据结构可以如图5所示。可以看到，该物联网项目定义的数据结构和rap文档系统定义的数据结构不同，而且基本上所有项目和rap文档系统上面的数据结构都不同。所以通过本实施例的转换和适配，可以将接口数据的数据结构转换为与目标文档系统适配的数据结构。例如，这种转换可以继续参考上述举例，例如可以将接口数据的请求参数重新组装成rap文档系统的请求参数，接口数据的响应参数转换成rap文档系统的响应参数，图5中requestParameterList就是请求参数，而responseParameterList则是响应参数。

S600，将请求数据录入到目标文档系统中。经过转换已与目标文档系统数据结构适配的请求数据则可以无阻碍地录入到目标文档系统中，以便进行统一管理和查阅。

本实施例和其他网页自动化录入等技术不同的地方在于，本实施例是针对源代码文件数据(接口数据)做处理的，是对所有项目都通用的，适应性非常强，是经过实践和证明的；而网上其他技术都不是通用的，要是网友增加限制之类的，他们就跑不通，数据也不完整不通用。

本实施例数据录入完整，不会遗漏任何数据，适应性很强。而且上传的云端系统是可以选择多样化，容易实现可视化；而其他技术都只是个数据库，没有可视化，只能开发人员去查看数据库，而不懂开发的人查不了。本实施例上传到云端系统，上传后非开发人员，比如测试人员，可以直接在上面查看。

总体上来说本申请具有适应性非常强，可用性，可视化性强，数据完整，发明通用等优秀的特征。

本申请实施例一种开发文档的自动化录入装置，包括：

任务配置模块，响应于目标程序的被触发，接收任务信息，然后根据所述任务信息查找并配置对应的生成配置信息及录入配置信息；

接口数据获取模块，根据所述生成配置信息，获取开发文档的接口数据；具体的，根据生成配置信息定位开发文档，然后利用JAVA的反射读取开发文档，最后通过解析开发文档上的参数信息获得接口数据。

请求调用模块，根据所述录入配置信息，登录对应的目标文档系统；

数据转换模块，将所述接口数据转换为请求数据，所述请求数据的数据结构被配置为与所述目标文档系统适配；

数据录入模块，将所述请求数据录入到所述目标文档系统中。

以上所述，仅为本发明较佳的具体实施方式，但本发明的保护范围并不局限于此，任何熟悉本技术领域的技术人员在本发明揭露的技术范围内，可轻易想到的变化或替换，都应涵盖在本发明的保护范围之内。因此，本发明的保护范围应该以权利要求的保护范围为准。