一种基于API元数据一致性比对系统及方法技术方案

技术编号:43836927 阅读:23 留言:0更新日期:2024-12-31 18:34
本发明专利技术公开了一种基于API元数据一致性比对系统及方法,所述系统包括:开发和集成SDK模块,用于开发Swagger SDK组件;文档比对模块,用于登记、管理和比对API元数据;实时和定期元数据比对模块,用于实施元数据比对机制,检测API定义和文档之间的不一致性;告警和通知模块,用于发送告警信息,告知API和参数发生了变化;版本控制和追溯模块,用于跟踪文档和源码的所有更改。本发明专利技术通过开发集成Swagger SDK,集成服务的API定义,暴露接口定义,文档比对模块从各应用服务抽取API接口定义,实时或定期比对API定义与文档的一致性,确保信息准确无误。

【技术实现步骤摘要】

本专利技术属于数据比对,具体是一种基于api元数据一致性比对系统及方法。


技术介绍

1、企业数字化转型的快速发展,诸多企业采用前后端分离、微服务架构模式构建业务系统,带来api数量爆发式增长。企业内部和企业间的api对接和维护成本成为一个迫切需要解决的问题。由于上下游系统对api变更的不透明,缺乏及时而全面的变更信息,使得故障风险极大,可能导致业务中断,直接损害企业的盈利能力和声誉。基于此种情形,需要对api接口的元数据进行检测登记,并在系统发版后及时检测api元数据信息,若发现变更,及时通知上下游系统。

2、目前保持接口文档与系统api源码的一致性,需开发者每次改动源码后,联系接口文档维护者,更新接口文档;源码的改动者,对文档进行复查,确保源码和接口文档保持一致性;消费者在使用文档开发程序对接的时候,若发现不一致,访问不符合预期,联系接口文档维护者,更新接口文档,确保文档和实际程序接口定义一致。

3、当前企业数字化转型中,api数量爆发式增长,api更新频繁,接口文档维护成本高;团队成员在更新源码时,团队人员流动时,忘记更新接口文本文档来自技高网...

【技术保护点】

1.一种基于API元数据一致性比对系统,其特征在于,所述系统包括:

2.如权利要求1所述的一种基于API元数据一致性比对系统,其特征在于,所述开发和集成SDK模块通过读取读物的Swagger JSON或YAML文件提取API详细信息。

3.如权利要求2所述的一种基于API元数据一致性比对系统,其特征在于,所述API详细信息包括路径、HTTP方案、参数类型、请求体和响应模型。

4.如权利要求1所述的一种基于API元数据一致性比对系统,其特征在于,所述文档比对模块包括:

5.如权利要求1所述的一种基于API元数据一致性比对系统,其特征在于,所述...

【技术特征摘要】

1.一种基于api元数据一致性比对系统,其特征在于,所述系统包括:

2.如权利要求1所述的一种基于api元数据一致性比对系统,其特征在于,所述开发和集成sdk模块通过读取读物的swagger json或yaml文件提取api详细信息。

3.如权利要求2所述的一种基于api元数据一致性比对系统,其特征在于,所述api详细信息包括路径、http方案、参数类型、请求体和响应模型。

4.如权利要求1所述的一种基于api元数据一致性比对系统,其特征在于,所述文档比对模块包括:

5.如权利要求1所述的一种基于api元数据一致性比对系统,其特征在于,所述实时和...

【专利技术属性】
技术研发人员:杨新彦杨金彬康黎翔
申请(专利权)人:北银金融科技有限责任公司
类型:发明
国别省市:

网友询问留言 已有0条评论
  • 还没有人留言评论。发表了对其他浏览者有用的留言会获得科技券。

1