[发明专利]接口文档生成方法、装置、设备及存储介质

说明书

本发明实施例提供一种接口文档生成方法、装置、设备及存储介质，通过从接口对应的多组测试数据中选择出至少一组测试范例候选数据(包括一组目标测试范例数据)，并确定出至少一组测试范例候选数据的数据格式，其次根据至少一组测试范例候选数据的数据格式进行合并处理，便可得到上述接口对应的目标测试范例数据的数据格式，然后根据上述目标测试范例数据和目标测试范例数据的数据格式，便可得到上述接口的接口文档。可见，本发明实施例实现了自动地生成上述接口的接口文档，可以大大节省人力成本和时间成本，从而提高了接口文档的生成效率。

技术领域

本发明实施例涉及计算机技术领域，尤其涉及一种接口文档生成方法、装置、设备及存储介质。

背景技术

通常情况下，程序代码会包括多个接口，以便于用户通过调用接口的方式来访问程序代码。

为了便于用户采用正确的调用方式，软件开发人员需要提供程序代码的接口文档。现有技术中，软件开发人员需要人工手动编写关于程序代码的接口文档。

在实现本发明过程中，发明人发现现有技术中至少存在如下问题：现有的人工手动编写接口文档的方式，需要消耗大量的人力成本和时间成本，因此，现有的接口文档的生成效率较低。

发明内容

本发明实施例提供一种接口文档生成方法、装置、设备及存储介质，用以解决现有技术中接口文档的生成效率较低的问题。

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

从接口对应的多组测试数据中确定出至少一组测试范例候选数据；其中，每组所述测试范例候选数据包括：输入测试范例数据和输出测试范例数据；所述至少一组测试范例候选数据中包括一组目标测试范例数据；

分别根据所述至少一组测试范例候选数据，确定每组所述测试范例候选数据的数据格式；其中，每组所述测试范例候选数据的数据格式包括：输入测试范例数据的数据格式和输出测试范例数据的数据格式；

对所述至少一组测试范例候选数据的数据格式进行合并，得到所述接口的目标测试范例数据的数据格式；其中，所述目标测试范例数据的数据格式包括：目标输入测试范例数据的数据格式和目标输出测试范例数据的数据格式，所述目标测试范例数据的数据格式中包括所述至少一组测试范例候选数据中的所有节点以及所述所有节点的信息；

根据所述目标测试范例数据和所述目标测试范例数据的数据格式，得到所述接口文档。

本发明实施例具有如下有益效果：通过从接口对应的多组测试数据中选择出至少一组测试范例候选数据(包括一组目标测试范例数据)，并确定出至少一组测试范例候选数据的数据格式，其次根据至少一组测试范例候选数据的数据格式进行合并处理，便可得到上述接口对应的目标测试范例数据的数据格式，然后根据上述目标测试范例数据和目标测试范例数据的数据格式，便可得到上述接口的接口文档。可见，本发明实施例实现了自动地生成上述接口的接口文档，可以大大节省人力成本和时间成本，从而提高了接口文档的生成效率。

在一种可能的实现方式中，所述分别根据所述至少一组测试范例候选数据，确定每组所述测试范例候选数据的数据格式，包括：

对于任意一组测试范例候选数据，根据所述测试范例候选数据中的输入测试范例候选数据和输出测试范例候选数据所包括的各节点的类型，确定所述测试范例候选数据的数据格式。

在一种可能的实现方式中，所述目标测试范例数据的数据格式中包括的任意节点的信息包括：节点的标识、类型和重要程度标识；

其中，节点的重要程度标识为重要或者非重要，重要程度标识为重要的节点为存在于所述至少一组测试范例候选数据中所有测试范例候选数据中的节点，重要程度标识为非重要的节点为只存在于所述至少一组测试范例候选数据中部分测试范例候选数据中的节点。