一种项目接口解析方法及相关装置制造方法及图纸

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

【技术实现步骤摘要】
一种项目接口解析方法及相关装置
本申请涉及计算机
，特别涉及一种项目接口解析方法、项目接口解析装置、服务器以及计算机可读存储介质。
技术介绍
在项目开发中，web项目的前后端分离开发，APP开发，需要由多个工程师共同定义接口，编写接口文档。在后续开发过程中，共同开发的工程师只需要通过接口文档进行开发，以便实现共同协作完成项目，到项目结束前都要一直维护。而在不同的开发环境中，接口文档可能并不是由工程师们共同指定，需要根据现有的服务分析出对应的接口文档。相关技术中，在微服务场景下，服务和服务之间的对接需要通过接口文档，接口文档的生成需要依赖接口的方法和数据模型信息。但是，通常情况下需要运行服务才能获取相应的接口方法和数据模型结构，其中运行服务的方式降低了解析效率，影响获取接口文档的速度。因此，如何在不运行服务的情况下获取接口方法和数据模型结构是本领域技术人员关注的重点问题。
技术实现思路
本申请的目的是提供一种项目接口解析方法、项目接口解析装置、服务器以及计算机可读存储介质，通过对代码文件和依赖包文件进行动态编译，确定到接口信息，并确定接口方法及参数，实现接口解析，而不是运行该代码实现解析，提高了解析效率。为解决上述技术问题，本申请提供一种项目接口解析方法，包括：获取目标项目的所有代码文件；通过mvn对所述目标项目进行依赖树结构分析，得到所有依赖包文件；对所述所有代码文件和所述所有依赖包文件进行动态编译，得到所有接口类信息；根据所述所有接口类信息确定对应的接口方法及参数。可选的，对所述所有代码文件和所述所有依赖包文件进行动态编译，得到所有接口类信息，包括：根据所述getTask方法对所述所有代码文件和所述所有依赖包文件进行动态编译；判断所述动态编译是否成功；若是，则进行遍历处理，得到所有类信息；根据接口类判断函数对所述所有类信息进行筛选，得到所述所有接口类信息。可选的，还包括：安装mvn环境，并对所述mvn环境进行环境变量配置。可选的，还包括：通过代码文档对所述所有接口类信息、对应的接口方法及参数添加注释信息，得到接口文档。可选的，还包括：通过自动脚本将所述接口文档生成为markdown接口文档，并上传至文档服务器中。本申请还提供一种项目接口解析装置，包括：代码文件获取模块，用于获取目标项目的所有代码文件；依赖包获取模块，用于通过mvn对所述目标项目进行依赖树结构分析，得到所有依赖包文件；动态编译模块，用于对所述所有代码文件和所述所有依赖包文件进行动态编译，得到所有接口类信息；信息获取模块，用于根据所述所有接口类信息确定对应的接口方法及参数。可选的，所述动态编译模块；编译单元，用于根据所述getTask方法对所述所有代码文件和所述所有依赖包文件进行动态编译；编译判断单元，用于判断所述动态编译是否成功；类信息获取单元，用于当所述动态编译成功时，进行遍历处理，得到所有类信息；类信息筛选单元，用于根据接口类判断函数对所述所有类信息进行筛选，得到所述所有接口类信息。可选的，还包括：mvn配置模块，用于安装mvn环境，并对所述mvn环境进行环境变量配置。本申请还提供一种服务器，包括：存储器，用于存储计算机程序；处理器，用于执行所述计算机程序时实现如上所述的项目接口解析方法的步骤。本申请还提供一种计算机可读存储介质，所述计算机可读存储介质上存储有计算机程序，所述计算机程序被处理器执行时实现如上所述的项目接口解析方法的步骤。本申请所提供的一种项目接口解析方法，包括：获取目标项目的所有代码文件；通过mvn对所述目标项目进行依赖树结构分析，得到所有依赖包文件；对所述所有代码文件和所述所有依赖包文件进行动态编译，得到所有接口类信息；根据所述所有接口类信息确定对应的接口方法及参数。通过对代码文件和依赖包文件进行动态编译，确定到接口信息，并确定接口方法及参数，实现接口解析，而不是运行该代码实现解析，提高了解析效率。本申请还提供一种项目接口解析装置、服务器以及计算机可读存储介质，具有以上有益效果，在此不做赘述。附图说明为了更清楚地说明本申请实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本申请的实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据提供的附图获得其他的附图。图1为本申请实施例所提供的一种项目接口解析方法的流程图；图2为本申请实施例所提供的一种项目接口解析装置的结构示意图。具体实施方式本申请的核心是提供一种项目接口解析方法、项目接口解析装置、服务器以及计算机可读存储介质，通过对代码文件和依赖包文件进行动态编译，确定到接口信息，并确定接口方法及参数，实现接口解析，而不是运行该代码实现解析，提高了解析效率。为使本申请实施例的目的、技术方案和优点更加清楚，下面将结合本申请实施例中的附图，对本申请实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例是本申请一部分实施例，而不是全部的实施例。基于本申请中的实施例，本领域普通技术人员在没有做出创造性劳动前提下所获得的所有其他实施例，都属于本申请保护的范围。相关技术中，在微服务场景下，服务和服务之间的对接需要通过接口文档，接口文档的生成需要依赖接口的方法和数据模型信息。但是，通常情况下需要运行服务才能获取相应的接口方法和数据模型结构，其中运行服务的方式降低了解析效率，影响获取接口文档的速度。因此，本申请提供了一种项目接口解析方法，通过对代码文件和依赖包文件进行动态编译，确定到接口信息，并确定接口方法及参数，实现接口解析，而不是运行该代码实现解析，提高了解析效率。以下通过一个实施例，对本申请提供的一种项目接口解析方法进行说明。请参考图1，图1为本申请实施例所提供的一种项目接口解析方法的流程图。本实施例中，该方法可以包括：S101，获取目标项目的所有代码文件；可见，本步骤中主要是获取到该目标项目的代码文件。其中，目标项目的代码文件，就是该项目下的所有代码文件。如果是Java项目，也是该项目路径下的所有扩展名为java的文件。S102，通过mvn对目标项目进行依赖树结构分析，得到所有依赖包文件；在S101的基础上，本步骤旨在通过mvn对目标项目进行依赖树结构分析，得到所有依赖包文件。其中，mvn(Maven，projectobjectmodel，项目对象模型)是可以通过一小段描述信息来管理项目的构建，并输出报告和文档的项目管理工具软件，可以对Java项目进行构建、依赖管理。因此，在mvn的基础上，可以通过mvndependency:tree命令对该目标本文档来自技高网...

【技术保护点】
1.一种项目接口解析方法，其特征在于，包括：/n获取目标项目的所有代码文件；/n通过mvn对所述目标项目进行依赖树结构分析，得到所有依赖包文件；/n对所述所有代码文件和所述所有依赖包文件进行动态编译，得到所有接口类信息；/n根据所述所有接口类信息确定对应的接口方法及参数。/n

【技术特征摘要】
1.一种项目接口解析方法，其特征在于，包括：
获取目标项目的所有代码文件；
通过mvn对所述目标项目进行依赖树结构分析，得到所有依赖包文件；
对所述所有代码文件和所述所有依赖包文件进行动态编译，得到所有接口类信息；
根据所述所有接口类信息确定对应的接口方法及参数。


2.根据权利要求1所述的项目接口解析方法，其特征在于，对所述所有代码文件和所述所有依赖包文件进行动态编译，得到所有接口类信息，包括：
根据所述getTask方法对所述所有代码文件和所述所有依赖包文件进行动态编译；
判断所述动态编译是否成功；
若是，则进行遍历处理，得到所有类信息；
根据接口类判断函数对所述所有类信息进行筛选，得到所述所有接口类信息。


3.根据权利要求1所述的项目接口解析方法，其特征在于，还包括：
安装mvn环境，并对所述mvn环境进行环境变量配置。


4.根据权利要求1所述的项目接口解析方法，其特征在于，还包括：
通过代码文档对所述所有接口类信息、对应的接口方法及参数添加注释信息，得到接口文档。


5.根据权利要求4所述的项目接口解析方法，其特征在于，还包括：
通过自动脚本将所述接口文档生成为markdown接口文档，并上传至文档服务器中。


6.一种项目接口解析装置，其特征在于，包括：
代码文件获取模块...

【专利技术属性】
技术研发人员：周海波，
申请(专利权)人：上海微盟企业发展有限公司，
类型：发明
国别省市：上海;31