接口文档更新方法、装置、设备及存储介质与流程

本发明涉及通信，尤其涉及一种接口文档更新方法、装置、设备及存储介质。

背景技术：

1、在开发中,应用与应用之间的交互通过api调用传递业务信息,随着业务的扩展,承载业务属性的api逐步增多,为了系统功能的稳定迭代,对于api的管理变得尤为重要，但对于数量庞大的api，管理难度日益增大。目前api的管理方案主要是通过线下文档编写记录该系统的全量api信息。每次更新api代码，需要手动更新接口文档。而纯人工线下更新手段落后，质量和效率无法保证，在修订文档时容易出现更新不及时或遗漏等情况，不利于高效开发与管理，并且在以后开发使用时可能因不准确带来开发障碍。

2、上述内容仅用于辅助理解本发明的技术方案，并不代表承认上述内容是现有技术。

技术实现思路

1、本发明的主要目的在于提供了一种接口文档更新方法、装置、设备及存储介质，旨在解决现有技术通过人工手动更新接口文档导致的接口文档更新效率低的技术问题。

2、为实现上述目的，本发明提供了一种接口文档更新方法，所述方法包括以下步骤：

3、获取部署在不同应用中的接口扫描器发送的接口数据；

4、为所述接口数据建立分类索引；

5、根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档。

6、可选地，所述为所述接口数据建立分类索引的步骤，包括：

7、对所述接口数据进行全量遍历，获得遍历结果；

8、根据所述遍历结果确定所述接口数据中的各个接口所属的目标应用和运行环境；

9、根据所述目标应用和所述运行环境为所述接口数据建立分类索引。

10、可选地，所述根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档的步骤，包括：

11、根据所述分类索引和所述接口数据确定所述接口数据中各个接口的版本信息；

12、根据所述版本信息对所述接口数据进行版本控制；

13、根据所述分类索引对所述接口数据进行运行环境控制；

14、根据版本控制结果和运行环境控制结果更新所述接口数据对应的接口文档。

15、可选地，所述根据所述分类索引对所述接口数据进行运行环境控制的步骤，包括：

16、基于所述分类索引，通过预设接口文档管理工具获取所述接口数据中各个接口在不同运行环境下的接口信息；

17、根据所述接口信息对所述接口数据进行运行环境控制。

18、可选地，所述根据所述版本信息对所述接口数据进行版本控制的步骤，包括：

19、根据所述版本信息确定所述接口数据中各个接口的更新日期和更新次数；

20、根据所述更新日期和所述更新次数对所述接口数据中各个接口进行版本控制。

21、可选地，所述获取部署在不同应用中的接口扫描器发送的接口数据的步骤，包括：

22、与部署在不同应用中的接口扫描器建立心跳连接；

23、判断与所述接口扫描器之间的心跳连接是否正常；

24、若否，则接收所述接口扫描器发送的接口数据。

25、此外，为实现上述目的，本发明提供了一种接口文档更新方法，所述方法包括以下步骤：

26、实时扫描待监控应用的应用代码，识别所述应用代码中的类文件；

27、从所述类文件中提取应用接口信息，并将所述应用接口信息转换为接口对象；

28、对所述接口对象进行序列化，获得接口数据，并将所述接口数据发送至文档更新服务器，以使所述文档更新服务器为所述接口数据建立分类索引，根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档。

29、此外，为实现上述目的，本发明还提供一种接口文档更新装置，所述装置包括：

30、获取模块，用于获取部署在不同应用中的接口扫描器发送的接口数据；

31、分类索引建立模块，用于为所述接口数据建立分类索引；

32、更新模块，用于根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档。

33、此外，为实现上述目的，本发明还提出一种接口文档更新设备，所述设备包括：存储器、处理器及存储在所述存储器上并可在所述处理器上运行的接口文档更新程序，所述接口文档更新程序配置为实现如上文所述的接口文档更新方法的步骤。

34、此外，为实现上述目的，本发明还提出一种存储介质，所述存储介质上存储有接口文档更新程序，所述接口文档更新程序被处理器执行时实现如上文所述的接口文档更新方法的步骤。

35、本发明获取部署在不同应用中的接口扫描器发送的接口数据；为所述接口数据建立分类索引；根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档。由于本发明是获取部署在不同应用中的接口扫描器发送的接口数据；为接口数据建立分类索引；根据分类索引对接口数据进行版本和运行环境控制，根据控制结果更新接口数据对应的接口文档。相对于现有的通过人工手动更新接口文档的方式，本发明上述方式能够保证接口文档更新的质量和效率，有利于高效开发与管理。

技术特征：

1.一种接口文档更新方法，其特征在于，所述接口文档更新方法包括以下步骤：

2.如权利要求1所述的接口文档更新方法，其特征在于，所述为所述接口数据建立分类索引的步骤，包括：

3.如权利要求1所述的接口文档更新方法，其特征在于，所述根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档的步骤，包括：

4.如权利要求3所述的接口文档更新方法，其特征在于，所述根据所述分类索引对所述接口数据进行运行环境控制的步骤，包括：

5.如权利要求3所述的接口文档更新方法，其特征在于，所述根据所述版本信息对所述接口数据进行版本控制的步骤，包括：

6.如权利要求1-5任一项所述的接口文档更新方法，其特征在于，所述获取部署在不同应用中的接口扫描器发送的接口数据的步骤，包括：

7.一种接口文档更新方法，其特征在于，所述接口文档更新方法包括以下步骤：

8.一种接口文档更新装置，其特征在于，所述接口文档更新装置包括：

9.一种接口文档更新设备，其特征在于，所述设备包括：存储器、处理器及存储在所述存储器上并可在所述处理器上运行的接口文档更新程序，所述接口文档更新程序配置为实现如权利要求1至6或7中任一项所述的接口文档更新方法的步骤。

10.一种存储介质，其特征在于，所述存储介质上存储有接口文档更新程序，所述接口文档更新程序被处理器执行时实现如权利要求1至6或7任一项所述的接口文档更新方法的步骤。

技术总结
本发明属于通信领域，公开了一种接口文档更新方法、装置、设备及存储介质。该方法包括：获取部署在不同应用中的接口扫描器发送的接口数据；为所述接口数据建立分类索引；根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档。由于本发明是获取部署在不同应用中的接口扫描器发送的接口数据；为接口数据建立分类索引；根据分类索引对接口数据进行版本和运行环境控制，根据控制结果更新接口数据对应的接口文档。相对于现有的通过人工手动更新接口文档的方式，本发明上述方式能够保证接口文档更新的质量和效率，有利于高效开发与管理。

技术研发人员：王璇,陈航,于祥兵,张皓恒,翁乐怡,张瑞麒,周玙菡,郭岳
受保护的技术使用者：中国移动通信集团浙江有限公司
技术研发日：
技术公布日：2024/1/15