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

说明书

本申请公开了一种接口文档的生成方法、装置、电子设备及存储介质，涉及网关技术领域，可用于云平台或云服务。具体实现方案为：从仓库中下载应用程序接口资源包；对应用程序接口资源包进行解析，获取接口文档的元信息；基于接口文档的元信息，生成所述接口文档。与现有技术相比，本申请不用开发人员手动编写接口文档，可以自动地实现接口文档的生成，能够有效地保证接口文档生成的准确性。而且避免后端开发人员手动编写接口文档，能够有效地节省人力，缩短接口文档的生成时间，提高接口文档的生成效率。

技术领域

本申请涉及计算机技术，尤其涉及网关技术领域，具体涉及一种接口文档的生成方法、装置、电子设备及存储介质。

背景技术

现有的网络中的资源业务系统大多采用分布式微服务来实现，具体由多个后端服务模块组成。这些后端服务模块都需要统一的网关来对外输出，以完成鉴权、流控、熔断等基础功能。例如，用户使用时，可以通过浏览器或者客户端等前端使用资源业务系统。前端与网关通过文本协议(如JSON)进行交互，而网关与后端服务模块均部署在企业内网，二者通过性能更高的二进制协议(如ProtoBuf)进行交互。

两种协议之间需要关于schema的翻译机制，即在前后端协同开发中，开发人员需要手动编写一份定义类的接口文档，用来描述接口信息，实现前端接口到后端接口的翻译。现有技术中，每当业务变更、服务升级时，都需要后端开发人员按照升级后的代码，手动编写接口文档。

但是，后端开发人员手动编写接口文档，极易出现编写错误，导致接口文档的准确性较低。

发明内容

为了解决上述技术问题，本申请提供了一种接口文档的生成方法、装置、电子设备及存储介质。

根据本申请的一方面，提供了一种接口文档的生成方法，其中，所述方法包括：

从仓库中下载应用程序接口资源包；

对所述应用程序接口资源包进行解析，获取接口文档的元信息；

基于所述接口文档的元信息，生成所述接口文档。

根据本申请的另一方面，提供了一种应用程序接口资源包的处理方法，其中，所述方法包括：

获取开发的应用程序接口资源包；

在所述应用程序接口资源包中设置埋点信息；

向仓库上传设置了所述埋点信息的所述应用程序接口资源包，以供接口文档生成装置下载所述应用程序接口资源包；基于设置的所述埋点信息对所述应用程序接口资源包进行解析，获取接口文档的元信息；并基于所述接口文档的元信息，生成所述接口文档。

根据本申请的再一方面，提供了一种接口文档的生成装置，其中，所述装置包括：

下载模块，用于从仓库中下载应用程序接口资源包；

解析模块，用于对所述应用程序接口资源包进行解析，获取接口文档的元信息；

生成模块，用于基于所述接口文档的元信息，生成所述接口文档。

根据本申请的又一方面，提供了一种应用程序接口资源包的处理装置，其中，所述装置包括：

获取模块，用于获取开发的应用程序接口资源包；

设置模块，用于在所述应用程序接口资源包中设置埋点信息；

上传模块，用于向仓库上传设置了所述埋点信息的所述应用程序接口资源包，以供接口文档生成装置下载所述应用程序接口资源包；基于设置的所述埋点信息对所述应用程序接口资源包进行解析，获取接口文档的元信息；并基于所述接口文档的元信息，生成所述接口文档。

根据本申请的再另一方面，提供了一种电子设备，包括：