生成接口文档的方法、装置、电子设备及介质制造方法及图纸

本申请公开了一种生成接口文档的方法、装置、电子设备及介质。通过应用本申请的技术方案，可以实现一种在确定未来即将发生数据交互事件后，根据数据交互对象以及数据交互类型针对性的为本次提供服务的接口信息生成对应接口文档的技术方案。从而一方面避免了相关技术中存在的，一旦数据交互双方的任一配置信息改变而导致的预先配置的接口文档无法实现数据交互的问题。另一方面也可以通过为接口信息配置时效性的方式，减少业务系统中堆积有大量过期接口文档所存在的耗费内存资源的问题。期接口文档所存在的耗费内存资源的问题。期接口文档所存在的耗费内存资源的问题。

【技术实现步骤摘要】
生成接口文档的方法、装置、电子设备及介质


[0001]本申请中涉及数据处理技术，尤其是一种生成接口文档的方法、装置、电子设备及介质。

技术介绍

[0002]随着计算机处理技术的快速发展，基于互联网的各类系统业务平台已经越来越多的被应用在针对用户服务的业务处理中。
[0003]相关技术中，在接口开发中不仅要写好接口，同时还要提供完善的接口文档。因此在原有的接口管理中，业务人员需要预先为每个接口按照规范编写接口文档，以使后续交互双方根据该接口文档实现数据的交互。
[0004]然而，上述方式会存在一个问题，即一旦交互双方的任意一方的配置信息发生变化时，预先配置的接口文档便也可能失效。从而出现只能由业务人员再次手动更新接口文档后才能实现二者的数据交互。这也导致影响业务进度。

技术实现思路

[0005]本申请实施例提供一种生成接口文档的方法、装置、电子设备及介质。用以解决相关技术中存在的，一旦配置信息改变而导致的预配置接口文档无法实现数据交互的问题。
[0006]其中，根据本申请实施例的一个方面，提供的一种生成接口本文档来自技高网...

【技术保护点】

【技术特征摘要】
1.一种生成接口文档的方法，其特征在于，包括：检测到在未来的预设时间段存在有交互事件，所述交互事件为至少两个待交互对象需要进行预设类型的数据交互，其中每个待交互对象所属于不同的业务平台；从接口列表中选取与所述预设类型相匹配的目标接口，并为所述目标接口配置与所述交互事件相匹配的预设生存时限；在所述目标接口的参数字段上，添加用于实现所述待交互对象进行数据交互的文档参数，得到目标接口文档，并通过所述目标接口将所述目标接口文档传输给所述至少两个待交互对象。2.如权利要求1所述的方法，其特征在于，所述在所述目标接口的参数字段上，添加用于实现所述待交互对象进行数据交互的文档参数，包括：在所述目标接口的访问控制参数字段上，添加每个待交互对象的访问地址与访问时间段；以及，在所述目标接口的业务控制参数字段上，添加每个待交互对象的业务交互类型；以及，在所述目标接口的业务控制参数字段上，添加每个待交互对象的版本号。3.如权利要求1或2所述的方法，其特征在于，所述在所述目标接口的参数字段上，添加用于实现所述待交互对象进行数据交互的文档参数，包括：配置所述目标接口对应的接口信息、输入参数信息、输出参数信息以及返回码信息；其中，所述接口信息包括：接口名称、接口程序描述；所述输入参数信息包括：输入参数描述，输入参数格式模板字符串、输入参数的格式定义字符串；所述输出参数信息包括：输出参数描述、输出参数字符串；所述返回码信息包括：返回码描述、返回码字符串。4.如权利要求1所述的方法，其特征在于，在所述目标接口的参数字段上，添加用于实现所述待交互对象进行数据交互的文档参数，得到目标接口文档之后，还包括：配置所述目标接口对应的测试用例代码，并将所述测试用例代码添加在所述目标接口文档中，其中所述测试用例代码用于对所述目标接口进行测试使用。5.如权利要求1或4所述的方法，其特征在于，所述通过所述目标接口将所述目标接口文档传输给所述至少两个待交互对象，包括：生成所述目标接口对应的参数映射脚本...

【专利技术属性】
技术研发人员：王立君，
申请(专利权)人：平安壹钱包电子商务有限公司，
类型：发明
国别省市：