[发明专利]接口文档自动生成方法、系统、终端及存储介质

权利要求书

1.一种接口文档自动生成方法，其特征在于，包括：

接收接口文档生成请求，所述接口文档生成请求包括至少一个项目信息；

从所述至少一个项目信息中提取出每个项目的接口信息；

从所述接口信息中分析出每个接口对应的域名信息；

利用所述接口信息生成接口文档；

将域名信息相同的接口文档进行聚合再输出。

2.根据权利要求1所述的接口文档自动生成方法，其特征在于，所述从所述至少一个项目中提取出每个项目的接口信息，包括：

将所述至少一个项目的接口信息统一导入至postman的一个collection中；

导出所述collection得到一个JSON格式文件，再对所述JSON格式文件进行解析，得到每个项目的接口信息。

3.根据权利要求1所述的接口文档自动生成方法，其特征在于，所述利用所述接口信息生成接口文档，包括：

分析所述接口信息并从所述接口信息中提取项目名称信息；

根据所述项目名称信息创建存储文件夹，每个项目的所有接口对应一个所述存储文件夹；

利用所述接口信息和Swagger规范生成每个接口对应的接口文档；

基于所述项目名称信息将所述接口文档存储至对应的所述存储文件夹。

4.根据权利要求3所述的接口文档自动生成方法，其特征在于，所述利用所述接口信息和Swagger规范生成每个接口对应的接口文档，包括：

将所述接口信息按照预设规则自动转换为所述Swagger规范规定格式的参数；

将所述参数填充至预先准备好的文档模板中，得到每个接口对应的所述接口文档。

5.根据权利要求4所述的接口文档自动生成方法，其特征在于，所述将所述接口信息按照预设规则自动转换为所述Swagger规范规定格式的参数之后，还包括：

判断每个接口对应的所述参数中是否包括认证参数；

若不包括，则将所述接口的认证参数设置为默认值并补全至所述参数中。

6.根据权利要求4所述的接口文档自动生成方法，其特征在于，所述将所述接口信息按照预设规则自动转换为所述Swagger规范规定格式的参数之后，还包括：

判断每个接口对应的所述参数中是否包括长度超过预设阈值的示例；

若包括，则按预设截断规则将所述示例截断为至少两段。

7.根据权利要求1所述的接口文档自动生成方法，其特征在于，所述将域名信息相同的接口文档进行聚合再输出之后，还包括：

将聚合后的接口文档上传至区块链中。

8.一种接口文档自动生成系统，其特征在于，包括：

接收模块，用于接收接口文档生成请求，所述接口文档生成请求包括至少一个项目信息；

提取模块，用于从所述至少一个项目信息中提取出每个项目的接口信息；

分析模块，用于从所述接口信息中分析出每个接口对应的域名信息；

生成模块，用于利用所述接口信息生成接口文档；

聚合模块，用于将域名信息相同的接口文档进行聚合再输出。

9.一种终端，其特征在于，所述终端包括处理器、与所述处理器耦接的存储器，其中，

所述存储器存储有用于实现如权利要求1-7中任一项所述的接口文档自动生成方法的程序指令；

所述处理器用于执行所述存储器存储的所述程序指令以生成接口文档且自动聚合。

10.一种存储介质，其特征在于，存储有能够实现如权利要求1-7中任一项所述的接口文档自动生成方法的程序文件。