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

说明书

本公开关于一种接口文档同步方法、装置、电子设备及存储介质。所述方法包括：接收接口文档同步接口被访问时传入的接口同步参数，并确定所述接口同步参数中的接口标识；根据预加载的文档同步配置信息，确定针对所述接口标识对应接口类型的文档扫描目录；读取在所述文档扫描目录中与所述接口标识对应接口的接口文档；其中，所述接口文档为根据所述接口的接口注解信息生成的；所述接口注解信息为读取所述接口的接口代码确定的；将所述接口文档同步至接口管理平台；所述接口管理平台用于向用户账户呈现所述接口文档。采用本公开可以提高软件项目开发的效率。

技术领域

本公开涉及计算机技术领域，尤其涉及一种接口文档同步方法、装置、电子设备及存储介质。

背景技术

随着计算机领域技术的发展，系统开发的复杂度在不断提高，一个项目需要多名开发人员共同开发。

相关技术中，开发人员通常需要通过查阅各种接口的接口代码来了解各种接口的功能以便于后续的开发。然而，由于各接口代码的代码编写风格不同、且代码内容繁多，开发人员通常需要花费大量时间去查阅各种接口的接口代码，不利于提高软件项目的开发效率。

发明内容

本公开提供一种接口文档同步方法、装置、电子设备及存储介质，以至少解决相关技术中提高软件项目开发效率的问题。本公开的技术方案如下：

根据本公开实施例的第一方面，提供一种接口文档同步方法，包括：

接收接口文档同步接口被访问时传入的接口同步参数，并确定所述接口同步参数中的接口标识；

根据预加载的文档同步配置信息，确定针对所述接口标识对应接口类型的文档扫描目录；

读取在所述文档扫描目录中与所述接口标识对应接口的接口文档；其中，所述接口文档为根据所述接口的接口注解信息生成的；所述接口注解信息为读取所述接口的接口代码确定的；

将所述接口文档同步至接口管理平台；所述接口管理平台用于向用户账户呈现所述接口文档。

在一种可能实现方式，所述将所述接口文档同步至接口管理平台，包括：获取针对所述接口文档的目标同步目录；所述目标同步目录为所述接口管理平台中用于存放所述接口文档的文件目录；基于所述目标同步目录和所述接口文档，生成文档同步指令；发送所述文档同步指令至所述接口管理平台的接口文档导入接口；所述接口文档导入接口用于响应所述文档同步指令，将所述接口文档导入至所述目标同步目录中。

在一种可能实现方式，所述获取针对所述接口文档的目标同步目录，包括：读取所述接口的接口代码，确定所述接口的同步目录注解信息；解析所述同步目录注解信息，确定针对所述接口文档的子级同步目录，以及，解析所述文档同步配置信息，确定针对所述接口文档的父级同步目录；根据所述父级同步目录和所述子级同步目录，构建所述目标同步目录。

在一种可能实现方式，在所述发送所述文档同步指令至所述接口管理平台的接口文档导入接口的步骤之后，所述方法还包括：接收所述接口文档导入接口返回的文档导入结果；解析所述文档导入结果，确定已导入所述接口管理平台的接口文档的数量信息。

在一种可能实现方式，所述方法还包括：加载所述文档同步配置信息，对预设的接口文档生成程序进行初始化，得到初始化后的接口文档生成程序；其中，所述初始化后的接口文档生成程序用于读取所述接口的接口代码，确定所述接口的接口注解信息，并根据所述接口注解信息，生成具有预设格式的接口描述文件；还用于将所述接口描述文件作为所述接口对应的接口文档保存至所述文档扫描目录中。

在一种可能实现方式，所述加载所述文档同步配置信息，对预设的接口文档生成程序进行初始化，得到初始化后的接口文档生成程序，包括：获取当前业务环境；若所述当前业务环境满足预设业务环境，则执行所述加载所述文档同步配置信息，对预设的接口文档生成程序进行初始化，得到初始化后的接口文档生成程序的步骤；其中，所述预设业务环境包括业务测试环境和业务开发环境中的至少一种。