[发明专利]一种生成接口文档的方法、系统和装置

权利要求书

1、一种生成接口文档的方法，其特征在于，包括以下步骤：

接收接口文档生成指令；

根据所述接口文档生成指令，读取接口配置文件，获取当前接口配置信息；

根据所述配置信息，为所述接口配置文件对应的接口生成接口文档。

2、如权利要求1所述自动生成接口文档的方法，其特征在于，所述接口文档生成指令，具体为：

根据接口文件的更新频率，设定自动发送所述接口文件生成指令的周期；

根据所述周期，发送所述接口文件生成指令。

3、如权利要求1所述自动生成接口文档的方法，其特征在于，所述接口文档生成指令，具体为：

实时检测系统更新信息；

当检测到所述系统的接口发生更改时，自动发送接口文件生成指令。

4、如权利要求1所述自动生成接口文档的方法，其特征在于，所述生成接口文档之后还包括：

输出所述接口文档，并覆盖所述接口的原有接口文档。

5、一种生成接口文档的系统，其特征在于，包括任务调度器和文档生成器：

所述任务调度器，用于发送接口文档生成指令；

所述文档生成器，用于根据所述任务调度器发送的接口文档生成指令，读取当前接口的配置文档，生成所述接口的接口文档。

6、一种任务调度器，其特征在于，包括：

模式设定模块，用于设置接口文档生成指令的发送模式；

指令发送模块，用于根据所述模式设定模块所设定的接口文档生成指令发送模式将接口文档生成指令发送给所述文档生成器。

7、如权利要求6所述的任务调度器，其特征在于，所述模式设定模块包括：

发送周期设定子模块，用于根据接口文件的更新频率要求，设定自动发送所述接口文件生成指令的周期。

8、如权利要求6所述的任务调度器，其特征在于，所述模式设定模块包括：

系统检测子模块，用于实时检测系统更新信息。

9、一种文档生成器，其特征在于，包括：

指令接收模块，用于接收所述任务调度器发送的接口文档生成指令；

文件分析模块，用于根据所述指令接收模块接收的接口文档生成指令，读取接口配置文件，获得所述接口的配置信息；

文档输出模块，用于根据所述文件读取模块所获取的接口配置信息，生成所述接口的接口文档，并输出所述接口文档，覆盖所述接口的原有接口文档。

10、如权利要求9所述的文档生成器，其特征在于，所述文件分析模块包括：

文件读取子模块，用于读取所述接口配置文件；

信息分析子模块，用于根据所述文件读取子模块所读取的接口配置文件，获得所述接口的配置信息。

11、如权利要求9所述的文档生成器，其特征在于，所述文档输出模块包括：

文档生成子模块，用于根据所述文件读取模块所获取的接口配置信息，生成所述接口的接口文档；

文件输出子模块，用于输出所述文档生成子模块所生成的接口文档，并覆盖所述接口的原有接口文档。