CN104375814A - 接口文档的生成方法及装置 - Google Patents

Abstract

本发明公开了一种接口文档的生成方法及装置，涉及数据处理领域，能够解决接口文档的编写费时，编写效率低的问题。所述方法包括：从配置文件中读取接口文档信息,所述接口文档信息用于描述接口程序；生成接口文档信息的显示界面；在所述显示界面中显示所述接口文档信息。本发明主要应用于接口文档维护与阅读的过程中。

Description

接口文档的生成方法及装置

技术领域

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

背景技术

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

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

发明内容

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

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

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

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

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

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

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

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

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

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

附图说明

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

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

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

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

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

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

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

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

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

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

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

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

具体实施方式

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

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

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

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

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

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

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

返回码信息包括：返回码描述（retCodeDesc），返回码字符串（retCodeStr）。

表1

步骤102、生成接口文档信息的显示界面。

如图2所示，显示界面分为四个部分，分别用于显示接口信息、输入参数信息、输出参数信息、返回码信息。

步骤103、在显示界面中显示接口文档信息。

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

本发明实施例还提供了一种接口文档的生成方法，作为对图1所示方法的具体说明，步骤102、生成接口文档信息的显示界面的具体实施方式如下：

生成接口文档信息的表格形式显示界面；

或者，生成接口文档信息的文本框形式显示界面；

或者，生成接口文档信息的代码形式显示界面。

表格形式显示界面如图3所示，在显示输入参数的各个表项中显示输入参数的格式定义字符串（optionalStr）。在表格中还显示有输入参数的类型（字符串或者整型等），通过复选框的显示输入参数是否必须填写、是否非空、是否非负。此外，根据输入参数的形状，在复选框中还可显示输入参数是否密码、是否为IP等。

文本框形式显示界面如图4所示，在不同的文本框中分别显示接口信息、输入参数信息、输出参数信息、返回码信息。

代码形式显示界面如图5所示，在该显示界面中，将配置文件的源代码进行显示。

本发明实施例提供的接口文档的生成方法，能够通过不同的显示界面显示配置文件中接在的接口文档信息，不同的显示界面适用于不同的用户，进而提高接口文档的可读性。

本发明实施例还提供了一种接口文档的生成方法，作为对图1所示方法的具体说明，步骤103、在所述界面中显示所述接口文档信息，可通过下述方式进行实施：

在所述界面中以递归方式分别显示所述输入参数信息、输出参数信息和返回码信息。

递归方式为将多个子属性合并到一个父属性中。一个程序可能存在多个输入参数、输出参数和返回码。在实施过程中，发明人发现在表示多个并列的属性值时，可属性值通过上一级别的属性值简化表示该多个并列的属性值。例如：如图6所示，地址、邮编、电话均为联系人的信息，此时可将地址、邮编、电话通过详细信息进行简化显示。

本发明实施例提供的接口文档的生成方法，通过邮编的递归方式的显示方式，能够简化用户的阅读量，提高接口文档的编辑效率。

本发明实施例还提供了一种接口文档的生成方法，作为对图1所示方法的进一步描述，在步骤101、从配置文件中读取接口文档信息之前，所述方法还包括：

显示配置文件输入界面；

接收用户通过所述配置文件输入界面输入的接口文档信息。

配置文件输入界面如图7所示，通过文本框形式显示配置文件中记载的接口文档信息。

本发明实施例提供的接口文档的生成方法，通过显示配置文件输入界面，能够简化用户边界配置文件的步骤。

本发明实施例还提供了一种接口文档的生成方法，作为对图1所示方法的进一步描述，如图8所示，在步骤103、在显示界面中显示所述接口文档信息之后，所述方法还包括：

步骤801、接收用户在显示界面中输入的更新信息，更新信息用于对已显示的接口文档信息进行修改。

用户可通过双击操作启动接收更新信息。当处于接收更新信息的状态时，在接收位置显示光标。或者，根据用户的点击位置确定更新的位置。

步骤802、将更新信息发送至版本控制服务器（SVN），其中，版本控制服务器对接口文档对应的程序进行更新。

如果用户通过“发送”功能按键，触发发送指示，则将更新信息发送至版本控制服务器。SVN根据接收到的更新信息对已存储的接口程序进行更新。

本发明实施例提供的接口文档的生成方法，为用户提供了接口文档的编辑界面。用户除了可以阅读接口文档的内容，同时通过显示界面对接口文档进行更新，进而提高接口文档的编辑效率。

需要说明的是，如图9所示，在显示界面中，可通过页面的形式，同时显示表格形式显示界面的索引按键、文本框形式显示界面的索引按键、代码形式显示界面的索引按键。根据用户选择的索引按键，显示索引按键对应的显示界面。在显示界面中，还可添加“保存”功能按键，用于将当前显示的接口文档信息发送到服务器进行保存。在发送的过程中，而使用透传的方式进行传输。

此外，还可通过只读方式显示接口文档信息，在只读方式中，不接受用户对接口文档信息的修改。

本发明实施例还提供了一种接口文档的生成装置，位于存储有接口程序的电子设备中，电子设备包括存储有接口程序的服务器等，如图10所示，所述装置1001包括：

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

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

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

进一步的，所述读取单元1还用于，从配置文件中读取接口信息、输入参数信息、输出参数信息、返回码信息。

进一步的，所述生成单元2还用于：

生成接口文档信息的表格形式显示界面；

或者，生成接口文档信息的文本框形式显示界面；

或者，生成接口文档信息的代码形式显示界面。

进一步的，所述显示单元3还用于，在所述界面中以递归方式分别显示所述输入参数信息、输出参数信息和返回码信息。

进一步的，所述显示单元3还用于，显示配置文件输入界面；

如图11所示，所述装置还包括：接收单元4和发送单元5。

所述接收单元4，用于接收用户通过所述显示单元3显示的所述配置文件输入界面输入的接口文档信息。

进一步的，所述接收单元4还用于，接收用户在所述显示界面中输入的更新信息，所述更新信息用于对已显示的接口文档信息进行修改；

所述装置包括：

发送单元5，用于将所述更新信息发送至版本控制服务器（SVN），其中，版本控制服务器对接口文档对应的程序进行更新。

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

所属领域的技术人员可以清楚地了解到，为描述的方便和简洁，仅以上述各功能模块的划分进行举例说明，实际应用中，可以根据需要而将上述功能分配由不同的功能模块完成，即将装置的内部结构划分成不同的功能模块，以完成以上描述的全部或者部分功能。上述描述的系统，装置和单元的具体工作过程，可以参考前述方法实施例中的对应过程，在此不再赘述。

以上所述，仅为本发明的具体实施方式，但本发明的保护范围并不局限于此，任何熟悉本技术领域的技术人员在本发明揭露的技术范围内，可轻易想到变化或替换，都应涵盖在本发明的保护范围之内。因此，本发明的保护范围应以所述权利要求的保护范围为准。

Claims (12)

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

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

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

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

2.根据权利要求1所述的方法，其特征在于，所述从配置文件中读取接口文档信息的步骤，包括：

从配置文件中读取接口信息、输入参数信息、输出参数信息、返回码信息。

3.根据权利要求2所述的方法，其特征在于，所述生成接口文档信息的显示界面的步骤，包括：

生成接口文档信息的表格形式显示界面；

或者，生成接口文档信息的文本框形式显示界面；

或者，生成接口文档信息的代码形式显示界面。

4.根据权利要求3所述的方法，其特征在于，所述在所述界面中显示所述接口文档信息的步骤，包括：

在所述界面中以递归方式分别显示所述输入参数信息、输出参数信息和返回码信息。

5.根据权利要求4所述的方法，其特征在于，在所述从配置文件中读取接口文档信息之前，所述方法还包括：

显示配置文件输入界面；

接收用户通过所述配置文件输入界面输入的接口文档信息。

6.根据权利要求5所述的方法，其特征在于，在所述显示界面中显示所述接口文档信息之后，所述方法还包括：

接收用户在所述显示界面中输入的更新信息，所述更新信息用于对已显示的接口文档信息进行修改；

将所述更新信息发送至版本控制服务器（SVN），其中，版本控制服务器对接口文档对应的程序进行更新。

7.一种接口文档的生成装置，其特征在于，包括：

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

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

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

8.根据权利要求7所述的装置，其特征在于，所述读取单元还用于，从配置文件中读取接口信息、输入参数信息、输出参数信息、返回码信息。

9.根据权利要求8所述的装置，其特征在于，所述生成单元还用于：

生成接口文档信息的表格形式显示界面；

或者，生成接口文档信息的文本框形式显示界面；

或者，生成接口文档信息的代码形式显示界面。

10.根据权利要求9所述的装置，其特征在于，所述显示单元还用于，在所述界面中以递归方式分别显示所述输入参数信息、输出参数信息和返回码信息。

11.根据权利要求10所述的装置，其特征在于，

所述显示单元还用于，显示配置文件输入界面；

所述装置还包括：

接收单元，用于接收用户通过所述显示单元显示的所述配置文件输入界面输入的接口文档信息。

12.根据权利要求11所述的装置，其特征在于，

所述接收单元还用于，接收用户在所述显示界面中输入的更新信息，所述更新信息用于对已显示的接口文档信息进行修改；

所述装置包括：

发送单元，用于将所述更新信息发送至版本控制服务器（SVN），其中，版本控制服务器对接口文档对应的程序进行更新。