[发明专利]接口文档的生成方法及装置

说明书

技术领域

本发明涉及数据处理领域，尤其涉及一种接口文档的生成方法及装置。

背景技术

接口文档用于描述接口程序的内容，例如输入参数的格式、输出参数的格式。如果只编写程序不编写接口文档，则程序员A编写的程序很难给程序员B使用。因此程序员除了编写程序之外，还需要编写接口文档。当程序发生变化时，程序员根据输入参数和输出参数的变化，对接口文档进行修改，以保证接口文档的准确性。

在实现上述接口文档的生成过程中，发明人发现现有技术中至少存在如下问题：由于接口文档都是以文本文档的方式进行显示，因此需要通过文字编辑工具进行接口文档的维护，程序员需要制作表格、根据接口的协议构造复杂的例子以保证文档准确性，导致编写费时，编写效率低。

发明内容

本发明提供的一种接口文档的生成方法及装置，能够解决接口文档的编写费时，编写效率低的问题。

一方面，本发明提供了一种接口文档的生成方法，包括：

从配置文件中读取接口文档信息,所述接口文档信息用于描述接口程序；

生成接口文档信息的显示界面；

在所述显示界面中显示所述接口文档信息。

另一方面，本发明还提供了一种接口文档的生成装置，包括：

读取单元，用于从配置文件中读取接口文档信息,所述接口文档信息用于描述接口程序；

生成单元，用于生成所述读取单元读取的接口文档信息的显示界面；

显示单元，用于在所述生成单元生成的所述显示界面中显示所述读取单元读取的所述接口文档信息。

本发明提供的接口文档的生成方法及装置，能够从配置文件中读取接口文档信息，在生成的显示界面中显示接口文档信息。现有技术中程序员需要制作表格、根据接口的协议构造复杂的例子以保证文档准确性，导致编写费时，编写效率低。本发明中，能够从配置文件中自动读取接口文档信息并在显示界面中显示接口文档信息，无需程序员对接口文档中的内容进行识别，进而简化接口文档的编辑，提高接口文档的维护效率。

附图说明

为了更清楚地说明本发明实施例或现有技术中的技术方案，下面将对实施例或现有技术描述中所需要使用的附图作简单地介绍，显而易见地，下面描述中的附图仅仅是本发明的一些实施例，对于本领域普通技术人员来讲，在不付出创造性劳动的前提下，还可以根据这些附图获得其他的附图。

图1为本发明实施例中一个接口文档的生成方法的流程图；

图2为本发明实施例中第一个显示界面的示意图；

图3为本发明实施例中第二个显示界面的示意图；

图4为本发明实施例中第三个显示界面的示意图；

图5为本发明实施例中第四个显示界面的示意图；

图6为本发明实施例中第五个显示界面的示意图；

图7为本发明实施例中配置文件输入界面的示意图；

图8为本发明实施例中另一个接口文档的生成方法的流程图；

图9为本发明实施例中第六个显示界面的示意图；

图10为本发明实施例中一个接口文档的生成装置的结构示意图；

图11为本发明实施例中另一个接口文档的生成装置的结构示意图。

具体实施方式

下面将结合本发明实施例中的附图，对本发明实施例中的技术方案进行清楚、完整地描述，显然，所描述的实施例仅仅是本发明一部分实施例，而不是全部的实施例。基于本发明中的实施例，本领域普通技术人员在没有作出创造性劳动前提下所获得的所有其他实施例，都属于本发明保护的范围。

本发明实施例提供了一种接口文档的生成方法，所述方法应用于存储有接口程序的电子设备中，如存储有接口程序的服务器等，如图1所示，所述方法包括：

步骤101、从配置文件中读取接口文档信息,接口文档信息用于描述接口程序。

配置文件的记录有描述接口文档的接口文档信息。通过json数组承载接口文档信息。接口文档信息包括：接口信息、输入参数信息、输出参数信息、返回码信息。配置文件的具体内容如表1所示，其中：

接口信息包括：接口名称（intfname）、接口程序描述（describe）。

输入参数信息包括：输入参数描述（inputDesc），输入参数格式模板字符串（templateStr）以及输入参数的格式定义字符串（optionalStr）。

输出参数信息包括：输出参数描述（outputDesc），输出参数字符串（outputStr）。