接口文档更新方法、装置、设备及存储介质制造方法及图纸

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

【技术实现步骤摘要】
接口文档更新方法、装置、设备及存储介质


[0001]本专利技术涉及通信
，尤其涉及一种接口文档更新方法、装置、设备及存储介质。

技术介绍

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

技术实现思路

[0004]本专利技术的主要目的在于提供了一种接口文档更新方法、装置、设备及存储介质，旨在解决现有技术通过人工手动更新接口文档导致的接口文档更新效率低的技术问题。
[0005]为实现上述目的，本专利技术提供了一种接口文档更新方法，所述方法包括以下步骤：
[0006]获取部署在不同应用中的接口扫描器发送的接口数据；
[0007]为所述接口数据建立分类索引；
[0008]根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档。
[0009]可选地，所述为所述接口数据建立分类索引的步骤，包括：/>[0010]对所述接口数据进行全量遍历，获得遍历结果；
[0011]根据所述遍历结果确定所述接口数据中的各个接口所属的目标应用和运行环境；
[0012]根据所述目标应用和所述运行环境为所述接口数据建立分类索引。
[0013]可选地，所述根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档的步骤，包括：
[0014]根据所述分类索引和所述接口数据确定所述接口数据中各个接口的版本信息；
[0015]根据所述版本信息对所述接口数据进行版本控制；
[0016]根据所述分类索引对所述接口数据进行运行环境控制；
[0017]根据版本控制结果和运行环境控制结果更新所述接口数据对应的接口文档。
[0018]可选地，所述根据所述分类索引对所述接口数据进行运行环境控制的步骤，包括：
[0019]基于所述分类索引，通过预设接口文档管理工具获取所述接口数据中各个接口在不同运行环境下的接口信息；
[0020]根据所述接口信息对所述接口数据进行运行环境控制。
[0021]可选地，所述根据所述版本信息对所述接口数据进行版本控制的步骤，包括：
[0022]根据所述版本信息确定所述接口数据中各个接口的更新日期和更新次数；
[0023]根据所述更新日期和所述更新次数对所述接口数据中各个接口进行版本控制。
[0024]可选地，所述获取部署在不同应用中的接口扫描器发送的接口数据的步骤，包括：
[0025]与部署在不同应用中的接口扫描器建立心跳连接；
[0026]判断与所述接口扫描器之间的心跳连接是否正常；
[0027]若否，则接收所述接口扫描器发送的接口数据。
[0028]此外，为实现上述目的，本专利技术提供了一种接口文档更新方法，所述方法包括以下步骤：
[0029]实时扫描待监控应用的应用代码，识别所述应用代码中的类文件；
[0030]从所述类文件中提取应用接口信息，并将所述应用接口信息转换为接口对象；
[0031]对所述接口对象进行序列化，获得接口数据，并将所述接口数据发送至文档更新服务器，以使所述文档更新服务器为所述接口数据建立分类索引，根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档。
[0032]此外，为实现上述目的，本专利技术还提供一种接口文档更新装置，所述装置包括：
[0033]获取模块，用于获取部署在不同应用中的接口扫描器发送的接口数据；
[0034]分类索引建立模块，用于为所述接口数据建立分类索引；
[0035]更新模块，用于根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档。
[0036]此外，为实现上述目的，本专利技术还提出一种接口文档更新设备，所述设备包括：存储器、处理器及存储在所述存储器上并可在所述处理器上运行的接口文档更新程序，所述接口文档更新程序配置为实现如上文所述的接口文档更新方法的步骤。
[0037]此外，为实现上述目的，本专利技术还提出一种存储介质，所述存储介质上存储有接口文档更新程序，所述接口文档更新程序被处理器执行时实现如上文所述的接口文档更新方法的步骤。
[0038]本专利技术获取部署在不同应用中的接口扫描器发送的接口数据；为所述接口数据建立分类索引；根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档。由于本专利技术是获取部署在不同应用中的接口扫描器发送的接口数据；为接口数据建立分类索引；根据分类索引对接口数据进行版本和运行环境控制，根据控制结果更新接口数据对应的接口文档。相对于现有的通过人工手动更新接口文档的方式，本专利技术上述方式能够保证接口文档更新的质量和效率，有利于高效开发与管理。
附图说明
[0039]图1是本专利技术实施例方案涉及的硬件运行环境的接口文档更新设备的结构示意图；
[0040]图2为本专利技术接口文档更新方法第一实施例的流程示意图；
[0041]图3为本专利技术接口文档更新方法第一实施例的接口接收器的功能示意图；
[0042]图4为本专利技术接口文档更新方法第二实施例的流程示意图；
[0043]图5为本专利技术接口文档更新方法第三实施例的流程示意图；
[0044]图6为本专利技术接口文档更新装置第一实施例的结构框图。
[0045]本专利技术目的的实现、功能特点及优点将结合实施例，参照附图做进一步说明。
具体实施方式
[0046]应当理解，此处所描述的具体实施例仅用以解释本专利技术，并不用于限定本专利技术。
[0047]参照图1，图1为本专利技术实施例方案涉及的硬件运行环境的接口文档更新设备结构示意图。
[0048]如图1所示，该接口文档更新设备可以包括：处理器1001，例如中央处理器(Central Processing Unit，CPU)，通信总线1002、用户接口1003，网络接口1004，存储器1005。其中，通信总线1002用于实现这些组件之间的连接通信。用户接口1003可以包括显示屏(Display)、输入单元比如键盘(Keyboard)，可选用户接口1003还可以包括标准的有线接口、无线接口。网络接口1004可选的可以包括标准的有线接口、无线接口(如无线保真(Wireless本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种接口文档更新方法，其特征在于，所述接口文档更新方法包括以下步骤：获取部署在不同应用中的接口扫描器发送的接口数据；为所述接口数据建立分类索引；根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档。2.如权利要求1所述的接口文档更新方法，其特征在于，所述为所述接口数据建立分类索引的步骤，包括：对所述接口数据进行全量遍历，获得遍历结果；根据所述遍历结果确定所述接口数据中的各个接口所属的目标应用和运行环境；根据所述目标应用和所述运行环境为所述接口数据建立分类索引。3.如权利要求1所述的接口文档更新方法，其特征在于，所述根据所述分类索引对所述接口数据进行版本和运行环境控制，并根据控制结果更新所述接口数据对应的接口文档的步骤，包括：根据所述分类索引和所述接口数据确定所述接口数据中各个接口的版本信息；根据所述版本信息对所述接口数据进行版本控制；根据所述分类索引对所述接口数据进行运行环境控制；根据版本控制结果和运行环境控制结果更新所述接口数据对应的接口文档。4.如权利要求3所述的接口文档更新方法，其特征在于，所述根据所述分类索引对所述接口数据进行运行环境控制的步骤，包括：基于所述分类索引，通过预设接口文档管理工具获取所述接口数据中各个接口在不同运行环境下的接口信息；根据所述接口信息对所述接口数据进行运行环境控制。5.如权利要求3所述的接口文档更新方法，其特征在于，所述根据所述版本信息对所述接口数据进行版本控制的步骤，包括：根据所述版本信息确定所述接口数据中各个接口的更新日期和更新次数；根据所述更新日期和所述更新次数对所述接口数据中各个接口进行版本控制...

【专利技术属性】
技术研发人员：王璇，陈航，于祥兵，张皓恒，翁乐怡，张瑞麒，周玙菡，郭岳，
申请(专利权)人：中国移动通信集团有限公司，
类型：发明
国别省市：