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

说明书

技术领域

本发明涉及系统技术领域，特别是涉及一种生成接口文档的方法、系统和装置。

背景技术

同一系统不同功能层之间的通信规则称为接口。

接口中可以声明属性、方法、事件和类型(Structure)，(但不能声明变量)，但是并不能设置这些成员的具体值，也就是说，只能定义，不能给它里面定义的东西赋值。

而对接口的配置进行描述的文件，就是接口配置文件，在现有技术中，工作人员需要通过读取接口配置文件，并根据接口配置文件中的信息，手工编写接口文档。

由于文档和系统实现是分离的，所以在系统接口发生改变，接口配置文件更新后，并不能第一时间生成新的接口文档，而是需要技术人员发现接口变更，而去读取接口配置文件，修改接口文档，从而使接口文档的更新完全依赖于技术人员主动对接口信息变更的发现，使接口文档的更新往往滞后，出现接口文档和系统实现不一致的问题，并可能由于技术人员的人为失误，出现接口文档撰写错误，准确率降低的后果，影响系统维护和正常工作。

因此，迫切需要提供一种新技术，是接口文档的更新或新接口文档的生成自动化，在系统接口发生变化后，自动生成新的接口文档，实现文档内容和系统实现的同步。

发明内容

本发明实施例要解决的问题是提供一种生成接口文档的方法、系统和装置，实现了接口文档和系统实现的自动同步，从而大大减轻了技术人员编写接口文档的工作量，并提高接口文档信息的准确性。

为达到上述目的，本发明实施例一方面提出一种生成接口文档的方法，包括以下步骤：

接收接口文档生成指令；

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

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

其中，所述接口文档生成指令，具体为：

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

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

其中，所述接口文档生成指令，具体为：

实时检测系统更新信息；

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

其中，所述生成接口文档之后还包括：

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

另一方面，本发明实施例还提供了一种生成接口文档的系统，其特征在于，包括：

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

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

另一方面，本发明实施例还提供了一种任务调度器，包括：

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

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

其中，所述模式设定模块包括：

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

其中，所述模式设定模块包括：

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

另一方面，本发明实施例还提供了一种文档生成器，包括：

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

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

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

其中，所述文件分析模块包括：

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

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

其中，所述文档输出模块包括：

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

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

本发明实施例的技术方案具有以下优点，因为采用了接口文档自动生成的方法，由系统自动生成接口文档，不再需要人共参与，达到了接口文档和系统实现的自动同步，提高文档描述的准确性，并进而降低技术人员编写文档工作量的效果。

附图说明