一种基于Protobuf的接口管理方法、设备及介质技术

本申请公开了一种基于Protobuf的接口管理方法、设备及介质，用以解决现有技术由于接口版本迭代或者修复变更等原因，使得接口逻辑发生变化，但无法及时更新接口，影响开发和测试进度的技术问题。方法包括：基于预先确定好的API接口契约得到API接口的全部定义及对应的接口描述语言IDL文件，并存储至预设的代码仓库；基于接口调用请求确定待调用API接口及对应目标开发语言类型，并确定代码仓库中目标开发语言类型的接口描述语言IDL文件；通过Protobuf编译器编译目标开发语言类型的接口描述语言IDL文件，以生成对应代码并返回至接口调用请求对应的接口调用方，实现对接口的管理，减少API接口的维护工作量，提高工作效率。提高工作效率。提高工作效率。

【技术实现步骤摘要】
一种基于Protobuf的接口管理方法、设备及介质


[0001]本申请涉及计算机
，尤其涉及一种基于Protobuf的接口管理方法、设备及介质。

技术介绍

[0002]目前，敏捷开发和前后端分离架构成为越来越常规的工作模式，后端只需提供统一的API接口，就能被Web、Android等多种客户端所使用，实现低耦合高内聚，提高代码的可维护性。但是，这种研发模式随着项目地不断推进、变更，项目规模也越来越大，API接口的数量也越来越多，维护成本也随之变得越来越高。API接口在设计完成后会编写与其对应的接口文档，在接口进行版本迭代后，需要及时对接口文档进行更新以保持接口文档与代码的同步，维护接口文档的工作量非常大。
[0003]随着接口版本的迭代，不断暴露出后期维护困难的问题：由于接口经历多次迭代，而接口文档未及时进行更新，导致实际代码逻辑与接口文档中的内容出现偏差，接口文档老旧不可用；由于修复问题、需求变更等原因导致接口产生逻辑变化，且修改后所产生的变更无法及时同步至前端团队及测试团队，影响开发和测试的进度。

技术实现思路

[0004]本申请实施例提供了一种基于Protobuf的接口管理方法、设备及介质，用以解决现有技术由于接口版本迭代或者修复变更等原因，使得接口逻辑发生变化，但无法及时更新接口，影响开发和测试进度的技术问题。
[0005]一方面，本申请实施例提供了一种基于Protobuf的接口管理方法，包括：
[0006]基于预先确定好的API接口契约，得到API接口的全部定义以及所述API接口的全部定义对应的接口描述语言IDL文件，并将所述接口描述语言IDL文件存储至预设的代码仓库中；
[0007]基于接口调用请求，确定出待调用API接口以及所述待调用API接口对应的目标开发语言类型，并在所述代码仓库中确定出所述待调用API接口对应目标开发语言类型的接口描述语言IDL文件；
[0008]通过Protobuf编译器对所述目标开发语言类型的接口描述语言IDL文件进行编译，生成所述目标开发语言类型的代码，并将所述代码返回至所述接口调用请求对应的接口调用方，实现对接口的管理。
[0009]在本申请的一种实现方式中，所述基于预先确定好的API接口契约，得到API接口的全部定义以及所述API接口的全部定义对应的接口描述语言IDL文件，并将所述接口描述语言IDL文件存储至预设的代码仓库中，具体包括：
[0010]接收接口提供方上传的可调用的API接口信息，并根据所述可调用的API接口信息，确定出可调用的API接口对应的API接口契约；
[0011]基于所述可调用的API接口对应的API接口契约，获得所述API接口对应的全部定
义以及所述API接口的全部定义对应的接口描述语言IDL文件；
[0012]将所述API接口以及所述接口描述语言IDL文件存储至预设的代码仓库中，并通过所述代码仓库对所述API接口进行管理。
[0013]在本申请的一种实现方式中，所述通过所述代码仓库对所述API接口进行管理，具体包括：
[0014]通过代码托管工具，对所述代码仓库中API接口对应的开发语言类型以及开发语言类型的接口描述语言IDL文件进行统一管理。
[0015]在本申请的一种实现方式中，所述将所述接口描述语言IDL文件存储至预设的代码仓库中之后，所述方法还包括：
[0016]获取接口提供方对API接口的处理请求，并在所述代码仓库中确定出所述处理请求对应的待处理API接口；
[0017]根据所述处理请求，对所述代码仓库文件中的待处理API接口进行相应的处理操作；所述处理操作至少包括：版本变更操作或者修改操作。
[0018]在本申请的一种实现方式中，所述基于接口调用请求，确定出待调用API接口以及所述待调用API接口对应的目标开发语言类型，并在所述代码仓库中确定出所述待调用API接口对应目标开发语言类型的接口描述语言IDL文件，具体包括：
[0019]接收接口调用方的接口调用请求，并根据所述接口调用请求，确定出所述接口调用方对应的待调用API接口以及所述待调用API接口对应的目标开发语言类型；
[0020]基于所述待调用API接口对应的目标开发语言类型，在所述代码仓库中确定出所述待调用API接口对应目标开发语言类型的接口描述语言IDL文件。
[0021]在本申请的一种实现方式中，所述通过Protobuf编译器对所述目标开发语言类型的接口描述语言IDL文件进行编译，生成所述目标开发语言类型的代码，具体包括：
[0022]确定出所述目标开发语言类型的Protobuf编译器；
[0023]基于所述目标开发语言类型的接口描述语言IDL文件，并通过所述目标开发语言类型的Protobuf编译器，生成所述目标开发语言类型的客户端代码以及服务端代码。
[0024]在本申请的一种实现方式中，所述API接口的全部定义至少包括以下一项或多项：路由器地址、输入内容、输出内容、接口名称以及字段类型。
[0025]在本申请的一种实现方式中，所述目标开发语言类型至少包括以下一项：java开发语言类型、go开发语言类型以及cpp开发语言类型。
[0026]另一方面，本申请实施例还提供了一种基于Protobuf的接口管理设备，所述设备包括：
[0027]至少一个处理器；
[0028]以及，与所述至少一个处理器通信连接的存储器；
[0029]其中，所述存储器存储有可被所述至少一个处理器执行的指令，所述指令被所述至少一个处理器执行，以使所述至少一个处理器能够执行如上述的一种基于Protobuf的接口管理方法。
[0030]另一方面，本申请实施例还提供了一种非易失性计算机存储介质，存储有计算机可执行指令，所述计算机可执行指令设置为：
[0031]如上述的一种基于Protobuf的接口管理方法。
[0032]本申请实施例提供了一种基于Protobuf的接口管理方法、设备及介质，至少包括以下有益效果：
[0033]通过获取API接口的全部定义以及API接口的全部定义对应的接口描述语言IDL文件，便于对接口描述语言IDL文件进行统一管理，减少维护API接口带来的工作量；通过每种目标开发语言类型对应的Protobuf编译器，分别编译生成对应目标开发语言类型的客户端代码和服务端代码，实现了代码的自动编译，提高了工作效率。
附图说明
[0034]此处所说明的附图用来提供对本申请的进一步理解，构成本申请的一部分，本申请的示意性实施例及其说明用于解释本申请，并不构成对本申请的不当限定。在附图中：
[0035]图1为本申请实施例提供的一种基于Protobuf的接口管理方法的流程示意图；
[0036]图2为本申请实施例提供的一种基于Protobuf的接口管理设备的内部结构示意图。
具体实施方式
[0037]为使本申请的目的、技术方案本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种基于Protobuf的接口管理方法，其特征在于，所述方法包括：基于预先确定好的API接口契约，得到API接口的全部定义以及所述API接口的全部定义对应的接口描述语言IDL文件，并将所述接口描述语言IDL文件存储至预设的代码仓库中；基于接口调用请求，确定出待调用API接口以及所述待调用API接口对应的目标开发语言类型，并在所述代码仓库中确定出所述待调用API接口对应目标开发语言类型的接口描述语言IDL文件；通过Protobuf编译器对所述目标开发语言类型的接口描述语言IDL文件进行编译，生成所述目标开发语言类型的代码，并将所述代码返回至所述接口调用请求对应的接口调用方，实现对接口的管理。2.根据权利要求1所述的一种基于Protobuf的接口管理方法，其特征在于，所述基于预先确定好的API接口契约，得到API接口的全部定义以及所述API接口的全部定义对应的接口描述语言IDL文件，并将所述接口描述语言IDL文件存储至预设的代码仓库中，具体包括：接收接口提供方上传的可调用的API接口信息，并根据所述可调用的API接口信息，确定出可调用的API接口对应的API接口契约；基于所述可调用的API接口对应的API接口契约，获得所述API接口对应的全部定义以及所述API接口的全部定义对应的接口描述语言IDL文件；将所述API接口以及所述接口描述语言IDL文件存储至预设的代码仓库中，并通过所述代码仓库对所述API接口进行管理。3.根据权利要求2所述的一种基于Protobuf的接口管理方法，其特征在于，所述通过所述代码仓库对所述API接口进行管理，具体包括：通过代码托管工具，对所述代码仓库中API接口对应的开发语言类型以及开发语言类型的接口描述语言IDL文件进行统一管理。4.根据权利要求1所述的一种基于Protobuf的接口管理方法，其特征在于，所述将所述接口描述语言IDL文件存储至预设的代码仓库中之后，所述方法还包括：获取接口提供方对API接口的处理请求，并在所述代码仓库中确定出所述处理请求对应的待处理API接口；根据所述处理请求，对所述代码仓库文件中的待处理API接口进行相应的处理操作；所述处理操作至少包括：版本变更操作或者修改操作。5.根据权利...

【专利技术属性】
技术研发人员：吕明逸，赵海兴，孙长杰，陈义蒙，
申请(专利权)人：浪潮卓数大数据产业发展有限公司，
类型：发明
国别省市：