[发明专利]一种项目接口解析方法及相关装置

说明书

本申请公开了一种项目接口解析方法，包括：获取目标项目的所有代码文件；通过mvn对所述目标项目进行依赖树结构分析，得到所有依赖包文件；对所述所有代码文件和所述所有依赖包文件进行动态编译，得到所有接口类信息；根据所述所有接口类信息确定对应的接口方法及参数。通过对代码文件和依赖包文件进行动态编译，确定到接口信息，并确定接口方法及参数，实现接口解析，而不是运行该代码实现s解析，提高了解析效率。本申请还公开了一种项目接口解析装置、服务器以及计算机可读存储介质，具有以上有益效果。

技术领域

本申请涉及计算机技术领域，特别涉及一种项目接口解析方法、项目接口解析装置、服务器以及计算机可读存储介质。

背景技术

在项目开发中，web项目的前后端分离开发，APP开发，需要由多个工程师共同定义接口，编写接口文档。在后续开发过程中，共同开发的工程师只需要通过接口文档进行开发，以便实现共同协作完成项目，到项目结束前都要一直维护。而在不同的开发环境中，接口文档可能并不是由工程师们共同指定，需要根据现有的服务分析出对应的接口文档。

相关技术中，在微服务场景下，服务和服务之间的对接需要通过接口文档，接口文档的生成需要依赖接口的方法和数据模型信息。但是，通常情况下需要运行服务才能获取相应的接口方法和数据模型结构，其中运行服务的方式降低了解析效率，影响获取接口文档的速度。

因此，如何在不运行服务的情况下获取接口方法和数据模型结构是本领域技术人员关注的重点问题。

发明内容

本申请的目的是提供一种项目接口解析方法、项目接口解析装置、服务器以及计算机可读存储介质，通过对代码文件和依赖包文件进行动态编译，确定到接口信息，并确定接口方法及参数，实现接口解析，而不是运行该代码实现解析，提高了解析效率。

为解决上述技术问题，本申请提供一种项目接口解析方法，包括：

获取目标项目的所有代码文件；

通过mvn对所述目标项目进行依赖树结构分析，得到所有依赖包文件；

对所述所有代码文件和所述所有依赖包文件进行动态编译，得到所有接口类信息；

根据所述所有接口类信息确定对应的接口方法及参数。

可选的，对所述所有代码文件和所述所有依赖包文件进行动态编译，得到所有接口类信息，包括：

根据所述getTask方法对所述所有代码文件和所述所有依赖包文件进行动态编译；

判断所述动态编译是否成功；

若是，则进行遍历处理，得到所有类信息；

根据接口类判断函数对所述所有类信息进行筛选，得到所述所有接口类信息。

可选的，还包括：

安装mvn环境，并对所述mvn环境进行环境变量配置。

可选的，还包括：

通过代码文档对所述所有接口类信息、对应的接口方法及参数添加注释信息，得到接口文档。

可选的，还包括：

通过自动脚本将所述接口文档生成为markdown接口文档，并上传至文档服务器中。

本申请还提供一种项目接口解析装置，包括：

代码文件获取模块，用于获取目标项目的所有代码文件；

依赖包获取模块，用于通过mvn对所述目标项目进行依赖树结构分析，得到所有依赖包文件；

动态编译模块，用于对所述所有代码文件和所述所有依赖包文件进行动态编译，得到所有接口类信息；