一种自动化生成接口文档的方法和系统技术方案

本发明专利技术提出了一种自动化生成接口文档的方法和系统。所述方法包括：通过扫描方式获取项目目录和程序文件内容；对所述项目目录和程序文件内容进行数据分析，获取项目接口列表和接口对应的参数信息；利用所述目接口列表和接口对应的参数信息生成接口文档；将所述接口文档和所述接口文档对应的项目目录和程序文件内容存储至数据库中，并建立所述项目目录和程序文件内容与所述接口文档之间的调用关系。所述系统包括与所述方法步骤对应的模块。述系统包括与所述方法步骤对应的模块。述系统包括与所述方法步骤对应的模块。

【技术实现步骤摘要】
一种自动化生成接口文档的方法和系统


[0001]本专利技术提出了一种自动化生成接口文档的方法和系统，属于接口数据处理


技术介绍

[0002]传统方式下服务接口文档是由人工手动编写，按照接口定义，人工提取接口信息，人工梳理数据关系，然后根据接口定义信息，一个一个字段提取出来写在文档上面。每个字段都需要在文档中注明字段名称、字段类型、字段是否可以为空、字段的默认值、字段的示例值、字段的描述等。这种方式导致接口处理的效率极低。

技术实现思路

[0003]本专利技术提供了一种自动化生成接口文档的方法和系统，用以解决现有技术中需要用户主动输入接口信息导致接口处理效率极低的问题：
[0004]一种自动化生成接口文档的方法，所述方法包括：
[0005]通过扫描方式获取项目目录和程序文件内容；
[0006]对所述项目目录和程序文件内容进行数据分析，获取项目接口列表和接口对应的参数信息；
[0007]利用所述目接口列表和接口对应的参数信息生成接口文档；
[0008]将所述接口文档和所述接口文档对应的项目目录和程序文件内容存储至数据库中，并建立所述项目目录和程序文件内容与所述接口文档之间的调用关系。
[0009]进一步地，通过扫描方式获取项目目录和程序文件内容，包括：
[0010]实时检测是否存在录入的项目信息；
[0011]当检测到存在录入的项目信息时，判断当前录入的所述项目信息是否为已生成接口文档的项目信息；
[0012]当判定当前录入的所述项目信息不是已生成接口文档的项目信息时，通过对项目信息进行扫描的方式获取项目目录和程序文件内容；
[0013]当判定当前录入的所述项目信息是已生成接口文档的项目信息时，提取对应的已生成的接口文档。
[0014]进一步地，当判定当前录入的所述项目信息是已生成接口文档的项目信息时，提取对应的已生成的接口文档，包括：
[0015]当判定当前录入的所述项目信息是已生成接口文档的项目信息时，提取所述项目信息对应的项目目录和程序文件内容；
[0016]扫描数据库，获取与当前所述项目目录和程序文件内容一致的数据库中已存储的项目目录和程序文件内容；
[0017]利用所述项目目录和程序文件内容与所述接口文档之间的调用关系，获取所述项目目录和程序文件内容对应的接口文档。
[0018]进一步地，利用所述目接口列表和接口对应的参数信息生成接口文档，包括：
[0019]根据所述项目目录和程序文件内容生成与所述项目目录和程序文件内容对应的测试用例；
[0020]利用所述测试用例对接口进行测试，获取与所述项目接口列表和接口对应的参数信息对应的接口返回值；
[0021]在获取所述接口返回值时，利用所述接口返回值生成接口文档。
[0022]一种自动化生成接口文档的系统，所述系统包括：
[0023]扫描获取模块，用于通过扫描方式获取项目目录和程序文件内容；
[0024]数据分析模块，用于对所述项目目录和程序文件内容进行数据分析，获取项目接口列表和接口对应的参数信息；
[0025]文档生成模块，用于利用所述目接口列表和接口对应的参数信息生成接口文档；
[0026]存储模块，用于将所述接口文档和所述接口文档对应的项目目录和程序文件内容存储至数据库中，并建立所述项目目录和程序文件内容与所述接口文档之间的调用关系。
[0027]进一步地，所述扫描获取模块包括：
[0028]实时监测模块，用于实时检测是否存在录入的项目信息；
[0029]判断模块，用于当检测到存在录入的项目信息时，判断当前录入的所述项目信息是否为已生成接口文档的项目信息；
[0030]第一判定模块，用于当判定当前录入的所述项目信息不是已生成接口文档的项目信息时，通过对项目信息进行扫描的方式获取项目目录和程序文件内容；
[0031]第二判定模块，用于当判定当前录入的所述项目信息是已生成接口文档的项目信息时，提取对应的已生成的接口文档。
[0032]进一步地，所述第二判定模块包括：
[0033]提取模块，用于当判定当前录入的所述项目信息是已生成接口文档的项目信息时，提取所述项目信息对应的项目目录和程序文件内容；
[0034]内容获取模块，用于扫描数据库，获取与当前所述项目目录和程序文件内容一致的数据库中已存储的项目目录和程序文件内容；
[0035]利用所述项目目录和程序文件内容与所述接口文档之间的调用关系，获取所述项目目录和程序文件内容对应的接口文档。
[0036]进一步地，所述文档生成模块包括：
[0037]用例生成模块，用于根据所述项目目录和程序文件内容生成与所述项目目录和程序文件内容对应的测试用例；
[0038]测试模块，用于利用所述测试用例对接口进行测试，获取与所述项目接口列表和接口对应的参数信息对应的接口返回值；
[0039]接口文档生成模块，用于在获取所述接口返回值时，利用所述接口返回值生成接口文档。
[0040]本专利技术有益效果：
[0041]本专利技术提出的一种自动化生成接口文档的方法和系统对项目目录、程序文件内容的扫描和自动化分析，获取项目接口列表和接口对应的参数信息，生成测试用例，对接口进行测试，获取接口返回值，生成接口文档。能够对项目进行自动化识别分析，生成接口文档，
减少人力，节约时间，提高接口文档处理效率。
附图说明
[0042]图1为本专利技术所述方法的流程图；
[0043]图2为本专利技术所述系统的系统框图。
具体实施方式
[0044]以下结合附图对本专利技术的优选实施例进行说明，应当理解，此处所描述的优选实施例仅用于说明和解释本专利技术，并不用于限定本专利技术。
[0045]本专利技术实施例提出了一种自动化生成接口文档的方法，如图1所示，所述方法包括：
[0046]S1、通过扫描方式获取项目目录和程序文件内容；
[0047]S2、对所述项目目录和程序文件内容进行数据分析，获取项目接口列表和接口对应的参数信息；
[0048]S3、利用所述目接口列表和接口对应的参数信息生成接口文档；
[0049]S4、将所述接口文档和所述接口文档对应的项目目录和程序文件内容存储至数据库中，并建立所述项目目录和程序文件内容与所述接口文档之间的调用关系。
[0050]上述技术方案的工作原理为：首先，通过扫描方式获取项目目录和程序文件内容；然后，对所述项目目录和程序文件内容进行数据分析，获取项目接口列表和接口对应的参数信息；随后，利用所述目接口列表和接口对应的参数信息生成接口文档；最后，将所述接口文档和所述接口文档对应的项目目录和程序文件内容存储至数据库中，并建立所述项目目录和程序文件内容与所述接口文档之间的调用关系。
[0051]上述技术方案的效果为：本实施例提出的一种自动化生成接口文档的方法对项目目录、程序文件本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种自动化生成接口文档的方法，其特征在于，所述方法包括：通过扫描方式获取项目目录和程序文件内容；对所述项目目录和程序文件内容进行数据分析，获取项目接口列表和接口对应的参数信息；利用所述目接口列表和接口对应的参数信息生成接口文档；将所述接口文档和所述接口文档对应的项目目录和程序文件内容存储至数据库中，并建立所述项目目录和程序文件内容与所述接口文档之间的调用关系。2.根据权利要求1所述方法，其特征在于，通过扫描方式获取项目目录和程序文件内容，包括：实时检测是否存在录入的项目信息；当检测到存在录入的项目信息时，判断当前录入的所述项目信息是否为已生成接口文档的项目信息；当判定当前录入的所述项目信息不是已生成接口文档的项目信息时，通过对项目信息进行扫描的方式获取项目目录和程序文件内容；当判定当前录入的所述项目信息是已生成接口文档的项目信息时，提取对应的已生成的接口文档。3.根据权利要求2所述方法，其特征在于，当判定当前录入的所述项目信息是已生成接口文档的项目信息时，提取对应的已生成的接口文档，包括：当判定当前录入的所述项目信息是已生成接口文档的项目信息时，提取所述项目信息对应的项目目录和程序文件内容；扫描数据库，获取与当前所述项目目录和程序文件内容一致的数据库中已存储的项目目录和程序文件内容；利用所述项目目录和程序文件内容与所述接口文档之间的调用关系，获取所述项目目录和程序文件内容对应的接口文档。4.根据权利要求1所述方法，其特征在于，利用所述目接口列表和接口对应的参数信息生成接口文档，包括：根据所述项目目录和程序文件内容生成与所述项目目录和程序文件内容对应的测试用例；利用所述测试用例对接口进行测试，获取与所述项目接口列表和接口对应的参数信息对应的接口返回值；在获取所述接口返回值时，利用所述接口返回值生成接口文档。5.一种自动化生成接口文档的系统，其特征在于，所述系统包括：...

【专利技术属性】
技术研发人员：余丹，兰雨晴，李其蓁，赵蒙蒙，王丹星，
申请(专利权)人：慧之安信息技术股份有限公司，
类型：发明
国别省市：