[发明专利]一种开发文档的自动化录入方法及装置

说明书

本发明提供一种开发文档的自动化录入方法及装置，包括：响应于被触发的目标程序，接收任务信息；根据所述任务信息，查找并配置对应的生成配置信息及录入配置信息；根据所述生成配置信息，获取所述开发文档的接口数据；根据所述录入配置信息，登录对应的目标文档系统；将所述接口数据转换为请求数据，所述请求数据的数据结构被配置为与所述目标文档系统适配；将所述请求数据录入到所述目标文档系统中。本发明的目的在于提供一种能够高效、低失误地将开发文档自动录入到文档系统中的方法。

技术领域

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

背景技术

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

发明内容

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

附图说明