一种接口文档数据生成方法、装置、设备及存储介质制造方法及图纸

本发明专利技术实施例公开了一种接口文档数据生成方法、装置、设备及存储介质。其中，该方法包括：扫描项目的所有源代码文件，将源代码文件中的文本数据保存在内存中；通过预设源代码解析工具对内存中的文本数据进行分析，根据分析结果确定项目中包含的应用程序编程接口API的外部定义的基本信息，并根据基本信息生成初始接口文档数据；从内存中加载文本数据，根据正则匹配规则对文本数据进行匹配，根据匹配结果确定API的内部定义的参数信息，并将参数信息增加至初始接口文档数据中，得到接口文档数据。本发明专利技术实施例提供的技术方案，能够识别出API接口内部代码定义的参数，生成的接口文档数据更全面。

【技术实现步骤摘要】
一种接口文档数据生成方法、装置、设备及存储介质
本专利技术实施例涉及计算机
，尤其涉及一种接口文档数据生成方法、装置、设备及存储介质。
技术介绍
API(ApplicationProgrammingInterface，应用程序编程接口)文档是目前系统开发的必备要求。尤其在现在常用的微服务架构或者前后端分离架构的驱动下，由于业务模块之间、前端与后台业务逻辑之间依赖性的下降，使得标准规范的API文档在系统开发过程中的作用尤为重要。目前，在Java开发体系中比较流行的是通过Swagger框架生成接口文档数据。Swagger是一种使用JSON表示的RESTfulAPI的接口描述语言，它与一组开源软件工具一起使用，从而达到设计、构建、记录和使用RESTfulWeb服务的目的。但是上述方法中需要维护额外的Swagger自定义的注解，并且无法识别接口内部代码定义的参数。
技术实现思路
本专利技术实施例提供了一种接口文档数据生成方法、装置、设备及存储介质，能够识别出API接口内部代码定义的参数，生成的接口文档数据更全面。第一方面，本专利技术实施例提供了一种接口文档数据生成方法，该方法包括：扫描项目的所有源代码文件，将所述源代码文件中的文本数据保存在内存中；通过预设源代码解析工具对所述内存中的文本数据进行分析，根据分析结果确定所述项目中包含的应用程序编程接口API的外部定义的基本信息，并根据所述基本信息生成初始接口文档数据；从所述内存中加载所述文本数据，根据正则匹配规则对所述文本数据进行匹配，根据匹配结果确定所述API的内部定义的参数信息，并将所述参数信息增加至所述初始接口文档数据中，得到接口文档数据。第二方面，本专利技术实施例提供了一种接口文档数据生成装置，该装置包括：数据保存模块，用于扫描项目的所有源代码文件，将所述源代码文件中的文本数据保存在内存中；数据生成模块，用于通过预设源代码解析工具对所述内存中的文本数据进行分析，根据分析结果确定所述项目中包含的应用程序编程接口API的外部定义的基本信息，并根据所述基本信息生成初始接口文档数据；数据确定模块，用于从所述内存中加载所述文本数据，根据正则匹配规则对所述文本数据进行匹配，根据匹配结果确定所述API的内部定义的参数信息，并将所述参数信息增加至所述初始接口文档数据中，得到接口文档数据。第三方面，本专利技术实施例提供了一种计算机设备，该计算机设备包括：一个或多个处理器；存储装置，用于存储一个或多个程序；当所述一个或多个程序被所述一个或多个处理器执行，使得所述一个或多个处理器实现本专利技术任意实施例所述的接口文档数据生成方法。第四方面，本专利技术实施例提供了一种计算机可读存储介质，其上存储有计算机程序，该程序被处理器执行时实现本专利技术任意实施例所述的接口文档数据生成方法。本专利技术实施例提供了一种接口文档数据生成方法、装置、设备及存储介质，首先扫描项目的所有源代码文件，将源代码文件中的文本数据保存在内存中，然后通过预设源代码解析工具对内存中的文本数据进行分析，根据分析结果确定项目中包含的API的外部定义的基本信息，并根据基本信息生成初始接口文档数据，最后从内存中加载文本数据，根据正则匹配规则对文本数据进行匹配，根据匹配结果确定API的内部定义的参数信息，并将参数信息增加至初始接口文档数据中，得到接口文档数据，能够识别出API接口内部代码定义的参数，生成的接口文档数据更全面。附图说明图1为本专利技术实施例一提供的一种接口文档数据生成方法的流程图；图2为本专利技术实施例二提供的一种接口文档数据生成方法的流程图；图3为本专利技术实施例三提供的一种接口文档数据生成装置的结构示意图；图4为本专利技术实施例四提供的一种计算机设备的结构示意图。具体实施方式下面结合附图和实施例对本专利技术作进一步的详细说明。可以理解的是，此处所描述的具体实施例仅仅用于解释本专利技术，而非对本专利技术的限定。另外还需要说明的是，为了便于描述，附图中仅示出了与本专利技术相关的部分而非全部结构。实施例一图1为本专利技术实施例一提供的一种接口文档数据生成方法的流程图，本实施例可适用于根据项目要求生成接口文档数据的情况。本实施例提供的接口文档数据生成方法可以由本专利技术实施例提供的接口文档数据生成装置来执行，该装置可以通过软件和/或硬件的方式实现，并集成在执行本方法的计算机设备中。参见图1，本实施例的方法包括但不限于如下步骤：S110，扫描项目的所有源代码文件，将源代码文件中的文本数据保存在内存中。在项目开发过程中，标准规范的API文档是非常重要的，为了准确的生成API接口文档数据，首先需要获取项目内包含的所有源代码文件，然后通过对项目内包含的所有源代码文件进行扫描，能够将源代码文件中的文本数据保存在内存中，方便后续直接从内存中加载文本数据以及对文本数据进行分析。可选的，本专利技术实施例所述的方法基于预设插件机制编写的插件实现，所述插件在所述项目的源代码目录中启动；所述扫描项目的所有源代码文件，将所述源代码文件中的文本数据保存在内存中，可以具体包括：接收到针对所述插件的启动指令时，通过在所述插件内扫描所述源代码目录内所述项目的所有源代码文件，将所述源代码文件中的文本数据保存在内存中。其中，预设插件机制可以为预先设计好的编写插件的工具，例如jQuery或者Maven等。启动指令可以为人工触发的。为了方便后续对源代码文件进行处理，在接收到针对插件的启动指令时，说明插件已经被启动，此时通过在插件内运行扫描源代码目录内项目的所有源代码文件，就能够将源代码文件中的文本数据保存在内存中。本专利技术实施例中，通过将源代码文件中的文本数据保存在内存中，不仅可以防止文本数据丢失，还能够方便后续对文本数据进行分析和处理。并且本专利技术实施例中的方法基于插件实现，因此项目中不需要引入额外的代码和注解等，能够实现代码零侵入，也不需要依赖其他开发工具的支持。S120，通过预设源代码解析工具对内存中的文本数据进行分析，根据分析结果确定项目中包含的API的外部定义的基本信息，并根据基本信息生成初始接口文档数据。其中，预设源代码解析工具可以与源代码文件采用的编程语言对应，具体可以基于编程语言进行选择，不同的编程语言所使用的源代码解析工具可以不同。例如源代码文件采用Java语言编写，按照javadoc标准编写代码注释，可以使用QDox工具或者Understand工具等对源代码进行解析。QDox是一款简单，高效的Java源代码解析器，可以提取Java类、接口、方法、参数名称、类型等。API的外部定义的基本信息可以理解为在代码编写过程针对API的功能或与外部对接时所需的信息进行规定的一些标准、参数或属性等信息。可选的，基本信息可以具体包括：接口名称、接口注释、API的外部定义的参数以及与API的外部定义的参数对应的注释。通过预设源代码解析工具对内存中的文本数据进行分析后，能够得到分本文档来自技高网...

【技术保护点】
1.一种接口文档数据生成方法，其特征在于，包括：/n扫描项目的所有源代码文件，将所述源代码文件中的文本数据保存在内存中；/n通过预设源代码解析工具对所述内存中的文本数据进行分析，根据分析结果确定所述项目中包含的应用程序编程接口API的外部定义的基本信息，并根据所述基本信息生成初始接口文档数据；/n从所述内存中加载所述文本数据，根据正则匹配规则对所述文本数据进行匹配，根据匹配结果确定所述API的内部定义的参数信息，并将所述参数信息增加至所述初始接口文档数据中，得到接口文档数据。/n

【技术特征摘要】
1.一种接口文档数据生成方法，其特征在于，包括：
扫描项目的所有源代码文件，将所述源代码文件中的文本数据保存在内存中；
通过预设源代码解析工具对所述内存中的文本数据进行分析，根据分析结果确定所述项目中包含的应用程序编程接口API的外部定义的基本信息，并根据所述基本信息生成初始接口文档数据；
从所述内存中加载所述文本数据，根据正则匹配规则对所述文本数据进行匹配，根据匹配结果确定所述API的内部定义的参数信息，并将所述参数信息增加至所述初始接口文档数据中，得到接口文档数据。


2.根据权利要求1所述的方法，其特征在于，所述方法基于预设插件机制编写的插件实现，所述插件在所述项目的源代码目录中启动；所述扫描项目的所有源代码文件，将所述源代码文件中的文本数据保存在内存中，包括：
接收到针对所述插件的启动指令时，通过在所述插件内扫描所述源代码目录内所述项目的所有源代码文件，将所述源代码文件中的文本数据保存在内存中。


3.根据权利要求1所述的方法，其特征在于，所述从所述内存中加载所述文本数据，根据正则匹配规则对所述文本数据进行匹配，根据匹配结果确定所述API的内部定义的参数信息，包括：
从所述内存中加载所述文本数据，将所述文本数据中的每一行文本按照正则匹配规则进行匹配，得到匹配成功的文本；
根据所述匹配成功的文本确定所述API的内部定义的参数信息。


4.根据权利要求1所述的方法，其特征在于，在将所述参数信息增加至所述初始接口文档数据中，得到接口文档数据之后，还包括：
确定所述项目对应的目标API管理系统；
将所述接口文档数据的数据格式转换为所述目标API管理系统对应的需求数据格式，得到目标接口文档数据；
将所述目标接口文档数据上传至所述目标API管理系统。


5.根据权利要求4所述的方法，其特征在于，所述确定所述项目对应的目标API管理系统，包括：
从所述项目对应的预设配置文件中读取目标API管理系统的目标身份标识；
相应的，所述将所述接口文档数据的数据格...

【专利技术属性】
技术研发人员：陈钊炬，刘熠，
申请(专利权)人：东莞市盟大塑化科技有限公司，
类型：发明
国别省市：广东;44