接口文档的生成方法、装置及存储介质与流程

本技术涉及接口处理，具体而言，涉及一种接口文档的生成方法、装置及存储介质。

背景技术：

1、应用程序之间的接口对接已成为实现互操作性的重要方式。接口对接所需的接口文档是确保应用程序之间数据交互和信息共享的重要工具，它能够提高应用程序的互操作性和可靠性，促进团队协作和信息传递的准确性。

2、目前，采用接口文档生成的方法所生成的接口文档中，通常包含了业务方的大部分信息。而针对某些业务方，其中一部分信息通常又不能向其提供，例如，业务提供方为医院，在业务使用方为患者的情况下，业务提供方的医生工资信息、艾滋病信息等通常是不能向患者提供的。

3、因此，采用目前的方案所生成的接口文档，存在较高的泄密风险。

技术实现思路

1、本技术目的在于一种接口文档的生成方法、装置及存储介质，通过对业务提供方与业务使用方进行审核，以对应生成相应的接口文档，能够一定程度上避免将可能造成泄密的信息提供给业务使用方，进而能够降低接口文档泄密的风险。

2、第一方面，本技术提供了一种接口文档的生成方法，其特征在于，包括：对业务提供方的业务提供接口进行审核，获得审核通过的业务提供接口；对业务使用方的业务使用接口进行审核，获得审核通过的业务使用接口；以及生成相互匹配的所述审核通过的业务提供接口与所述审核通过的业务使用接口对接所需的接口文档。

3、上述接口文档的生成方法，通过对业务提供方与业务使用方进行审核，以对应生成相应的接口文档，一定程度上避免了将可能造成泄密的信息提供给业务使用方，进而降低了接口文档泄密的风险。

4、结合第一方面，可选地，所述对业务提供方的业务提供接口进行审核，获得审核通过的业务提供接口，包括：获取所述业务提供方的第一基本信息与业务提供接口信息；根据所述第一基本信息与业务提供接口信息，对所述业务提供接口进行审核；以及获得所述审核通过的业务提供接口。

5、上述接口文档的生成方法，通过获取业务提供方具体的第一基本信息与业务提供接口信息，并根据该第一基本信息与业务提供接口信息对业务提供方的业务提供接口进行审核，提高了对业务提供方的业务提供接口进行审核的准确性，进而进一步避免了将可能造成泄密的信息提供给业务使用方，降低了接口文档泄密的风险。

6、结合第一方面，可选地，所述获取所述业务提供方的第一基本信息与业务提供接口信息，包括：利用第一状态字段记录所述业务提供接口的当前状态；其中，第一状态字段表征所述业务提供接口在审核中；所述获得所述审核通过的业务提供接口，包括：利用第二状态字段记录所述述审核通过的业务提供接口的当前状态；其中，第二状态字段表征所述业务提供接口审核通过。

7、上述接口文档的生成方法，分别通过第一状态字段与第二状态字段记录业务提供接口不同的审核状态。使得对审核完成与审核未完成的业务提供接口的管理更加有序，进而提高了对业务提供接口进行审核的效率。

8、结合第一方面，可选地，所述对业务使用方的业务使用接口进行审核，获得审核通过的业务使用接口，包括：获取所述业务使用方的第二基本信息与业务使用接口信息；根据所述第二基本信息与业务使用接口信息，对所述业务使用接口进行审核；以及获得所述审核通过的业务使用接口。

9、上述接口文档的生成方法，通过获取业务提供方具体的第二基本信息与业务使用接口信息，并根据该第二基本信息与业务使用接口信息对业务使用方的业务使用接口进行审核，提高了对业务使用方的业务使用接口进行审核的准确性，进而同样进一步避免了将可能造成泄密的信息提供给业务使用方，降低了接口文档泄密的风险。

10、结合第一方面，可选地，所述获取所述业务使用方的第二基本信息与业务使用接口信息，包括：利用第三状态字段记录所述业务使用接口的当前状态；其中，第三状态字段表征所述业务使用接口在审核中；所述获得所述审核通过的业务使用接口，包括：利用第四状态字段记录所述述审核通过的业务使用接口的当前状态；其中，第四状态字段表征所述业务使用接口审核通过。

11、上述接口文档的生成方法，分别通过第三状态字段与第四状态字段记录业务使用接口不同的审核状态。使得对审核完成与审核未完成的业务使用接口的管理更加有序，进而提高了对业务使用接口进行审核的效率。

12、结合第一方面，可选地，所述生成相互匹配的所述审核通过的业务提供接口与所述审核通过的业务使用接口对接所需的接口文档，包括：获取所述业务使用方的选择信息；其中，所述选择信息表征所述业务使用方所需要对接的所述业务提供接口；对所述选择信息进行审核，获得允许与所述审核通过的业务使用接口进行对接的所述审核通过的业务提供接口；根据所述审核通过的业务提供接口以及允许对接的所述审核通过的业务提供接口，生成所述接口文档。

13、上述接口文档的生成方法，通过根据具体的业务使用方与业务提供方的信息，针对性允许或拒绝其之间接口的对接，并生成对应的接口文档，进一步避免了将可能造成泄密的信息提供给业务使用方，进而进一步降低了接口文档泄密的风险。

14、结合第一方面，可选地，所述生成相互匹配的所述审核通过的业务提供接口与所述审核通过的业务使用接口对接所需的接口文档，包括：获取所述审核通过的业务提供接口的业务提供接口信息、所述审核通过的业务使用接口的业务使用接口信息；以及利用所述业务提供接口信息与所述业务使用接口信息替换模板引擎中的变量参数，获得所述接口文档。

15、上述接口文档的生成方法，通过采用模板引擎生成接口文档，提高了接口文档生成的效率以及灵活性。

16、结合第一方面，可选地，所述利用所述业务提供接口信息与所述业务使用接口信息替换模板引擎中的变量参数，获得所述接口文档，包括：所述利用所述业务提供接口信息与所述业务使用接口信息替换模板引擎中的变量参数，获得动态的所述接口文档；以及利用文档转换工具对动态的所述接口文档进行填充，获得静态的所述接口文档。

17、上述接口文档的生成方法，通过利用文档转换工具将动态的接口文档转换成静态的接口文档，更加方便了用户对接口文档的浏览。

18、第二方面，本技术还提供了一种接口文档的生成装置，包括：审核模块以及生成模块；所述审核模块用于对业务提供方的业务提供接口进行审核，获得审核通过的业务提供接口；所述审核模块还用于对业务使用方的业务使用接口进行审核，获得审核通过的业务使用接口；所述生成模块用于生成相互匹配的所述审核通过的业务提供接口与所述审核通过的业务使用接口对接所需的接口文档。

19、上述接口文档的生成装置，具有与上述第一方面，或第一方面的任意一种可选地实施方式所提供的一种接口文档的生成方法相同的有益效果，此处不作赘述。

20、第三方面，本技术还提供了一种电子设备，包括：处理器和存储器，存储器存储有处理器可执行的机器可读指令，机器可读指令被处理器执行时执行如上面描述的方法。

21、上述电子设备，具有与上述第一方面，或第一方面的任意一种可选地实施方式所提供的一种接口文档的生成方法相同的有益效果，此处不作赘述。

22、第四方面，本技术还提供了一种存储介质，所述存储介质包括计算机可读存储介质，所述计算机可读存储介质上存储有计算机程序，该计算机程序被处理器运行时执行上面描述的方法。

23、上述存储介质，具有与上述第一方面，或第一方面的任意一种可选地实施方式所提供的一种接口文档的生成方法相同的有益效果，此处不作赘述。

24、本技术提供的接口文档的生成方法、装置及存储介质，通过对业务提供方与业务使用方进行审核，以对应生成相应的接口文档，一定程度上避免了将可能造成泄密的信息提供给业务使用方，进而降低了接口文档泄密的风险。分别通过第一状态字段与第二状态字段记录业务提供接口不同的审核状态，分别通过第三状态字段与第四状态字段记录业务使用接口不同的审核状态，使得对审核完成与审核未完成的业务提供接口以及业务使用接口的管理更加有序，进而提高了对业务提供接口进行审核的效率。具体通过获取业务提供方具体的第二基本信息与业务使用接口信息，并根据该第二基本信息与业务使用接口信息对业务使用方的业务使用接口进行审核，提高了对业务使用方的业务使用接口进行审核的准确性，进而同样进一步避免了将可能造成泄密的信息提供给业务使用方，降低了接口文档泄密的风险。