[发明专利]接口文档生成方法、终端设备及计算机可读存储介质

权利要求书

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

轮询指定路径下的所有代码文件的修改时间；

根据所有所述代码文件的修改时间，从所有所述代码文件中获取所述修改时间距离系统当前时间最近的目标文件；

扫描所述目标文件，从所述目标文件的代码注释中确定被修改的代码接口，并提取所述代码接口的关键字段；

根据所述代码接口及所述代码接口的关键字段，生成预设格式的接口文档。

2.根据权利要求1所述的接口文档生成方法，其特征在于，所述扫描所述目标文件，从所述目标文件的代码注释中确定被修改的代码接口包括：

采用正则匹配的方式扫描所述目标文件；

从所述目标文件的代码注释中，查询各个代码接口的更新时间字段，并从中确定出修改时间处于轮询时段内的被修改的代码接口；

其中，所述更新时间字段用于指示所述代码接口的修改时间。

3.根据权利要求1所述的接口文档生成方法，其特征在于，所述根据所述代码接口及所述代码接口的关键字段，生成预设格式的接口文档包括：

若所述目标文件已存在有对应的接口文档，则采用追加的方式在预设格式的所述接口文档的结尾处写入关于所述代码接口及所述代码接口的关键字段的注释信息；

若所述目标文件不存在有对应的接口文档，则直接根据所述代码接口及所述代码接口的关键字段生成预设格式的接口文档。

4.根据权利要求1所述的接口文档生成方法，其特征在于，所述生成预设格式的接口文档之后，还包括：

将预设格式的所述接口文档提交至代码仓库GitHub中，以对所述接口文档进行查阅。

5.根据权利要求1-4中任一项所述的接口文档生成方法，其特征在于，所述关键字段包括以下中的至少一项：更新时间@Time字段、请求方法@method字段、参数@param字段、接口地址@Url字段、接口描述@Description字段及返回结果@Return字段。

6.一种终端设备，其特征在于，包括：处理器以及和处理器相连的存储器；其中，所述存储器包括计算机可读指令；所述处理器用于执行所述存储器中的计算机可读指令，从而使得所述终端设备执行如下步骤：

轮询指定路径下的所有代码文件的修改时间；

根据所有所述代码文件的修改时间，从所有所述代码文件中获取所述修改时间距离系统当前时间最近的目标文件；

扫描所述目标文件，从所述目标文件的代码注释中确定被修改的代码接口，并提取所述代码接口的关键字段；

根据所述代码接口及所述代码接口的关键字段，生成预设格式的接口文档。

7.根据权利要求6所述的终端设备，其特征在于，所述终端设备具体用于执行如下步骤：

采用正则匹配的方式扫描所述目标文件；

从所述目标文件的代码注释中，查询各个代码接口的更新时间字段，并从中确定出修改时间处于轮询时段内的被修改的代码接口；

其中，所述更新时间字段用于指示所述代码接口的修改时间。

8.根据权利要求6所述的终端设备，其特征在于，所述终端设备具体用于执行如下步骤：

若所述目标文件已存在有对应的接口文档，则采用追加的方式在预设格式的所述接口文档的结尾处写入关于所述代码接口及所述代码接口的关键字段的注释信息；

若所述目标文件不存在有对应的接口文档，则直接根据所述代码接口及所述代码接口的关键字段生成预设格式的接口文档。

9.根据权利要求6所述的终端设备，其特征在于，所述生成预设格式的接口文档之后，所述终端设备还用于执行如下步骤：

将预设格式的所述接口文档提交至代码仓库GitHub中，以对所述接口文档进行查阅。