数据服务最佳实践(2):利用API的多版本管理能力提升API管理效率【Dataphin V3.11】

简介: 在DataphinV3.11版本中,Dataphin支持了API开发多版本管理,对API变更过程进行记录和维护,便于追溯历史版本和保障下游调用不受影响。

在DataphinV3.11版本中,Dataphin支持了API开发多版本管理,对API变更过程进行记录和维护,便于追溯历史版本和保障下游调用不受影响。


一、场景介绍

场景1:API开发多版本

开发人员开发的API发布到线上使用后,在调用一段时间,发现SQL的取数逻辑有问题,需要修改SQL语句,开发人员可以新增一个版本V1.1,基于原有的版本V1.0修改SQL语句,在API测试时,可以对V1.0和V1.1进行测试对比,验证SQL的取数逻辑是否正确,测试通过后,可将新版本V1.1发布到线上使用。

场景2:API回退到历史版本的取数逻辑

API新版本发布V1.1到线上使用后,发现调用返回的数据有问题,希望回退到上一版本V1.0的取数逻辑。开发人员可以基于V1.0版本,直接新增V2.0版本,不做修正直接提交并发布V1.1版本即可实现回退到上一版本的取数逻辑。(不直接使用1.0版本回退覆盖是考虑每个版本使用时段都能跟踪追溯)


二、API多版本管理能力介绍

1、API版本管理

新增API后,点击API的版本管理,可以查看API的版本列表,展示API开发过程中的所有版本,对已提交过的版本支持版本测试和版本对比。

新增API版本:可以基于某一版本新增版本

新增版本:基于原有的版本配置,调整取数逻辑

版本对比:当存在多个非草稿态版本时,支持进行版本对比,配置信息不一致的会高亮。


2、API测试-多版本共存

当存在多个非草稿态版本时,支持切换测试不同版本的API

注:如果已有发布到线上版本,为确保不影响线上API的正常调用。新版本配置的参数信息会与原线上版本对比,若新增版本增加了必填请求参数、删减了请求/返回参数、修改了请求参数的参数类型均不允许、保存、提交和发布,避免该版本发布到线上后影响API的正常调用。


三、视频操作手册

有关数据服务支持多版本能力的详细功能,可以参考操作视频:


四、结语

支持API开发多版本后,企业的API开发者可以实现对API多版本的管理和维护,提升API的开发效率和管理效率。

升级到3.11的新版本之后,历史的API会进行数据升级,将历史API的草稿态、开发态、生产态的API参数配置生成不同的版本,保证历史API的正常使用。用户可以结合企业的实际业务诉求和新的产品能力,管理升级后生成的版本数据。

更多历史内容详见:

数据服务最佳实践(1):支持注册外部API,打造企业数据服务中心【Dataphin V3.11】

相关文章
|
11月前
|
JSON 安全 Java
API 一键转换 MCP 服务!Higress 助今日投资快速上线 MCP 市场
今日投资的技术负责人介绍了如何通过Higress MCP 市场完善的解决方案,快捷地将丰富的金融数据 API 转化为 MCP 工具,帮助用户通过 MCP 的方式非常轻松地调用专业金融数据,自由快速地构建自己的金融大模型应用。
1289 23
|
9月前
|
SQL 运维 关系型数据库
【产品升级】Dataphin V5.0版本发布:助力出海业务、增全量一体集成、异步调用API等更多功能等你发现
Dataphin是瓴羊推出的智能数据建设与治理平台,基于阿里巴巴内部实践,提供一站式数据建设与治理能力。V5.0版本研发新增支持Databricks作为离线计算引擎、支持MySQL数据库一键增全量同步、支持管理Hudi、Delta Lake表等;资产运营与消费持续提效,支持批量编辑目录名称及描述、Quick BI仪表板的上架管理等功能,增加资产可用性与盘点效率。
436 8
|
9月前
|
SQL 人工智能 搜索推荐
Dataphin功能Tips系列(71)X-数据管家:数据资产运营的「AI外挂」
在企业数据治理中,数据资产规模庞大、字段繁多,手动录入效率低且易出错。Dataphin推出「X-数据管家」,利用大模型智能生成标签、描述及字段类型等信息,支持一键批量上架,大幅提升资产运营效率。
296 0
|
11月前
|
API
Dataphin功能Tips系列(58)- 支持OAuth2.0认证方式的API数据源
在数据集成过程中,Dataphin需通过API从外部系统获取数据,而这些系统常采用动态令牌鉴权机制。本文介绍如何在Dataphin中配置支持OAuth 2.0认证的API数据源,实现自动获取和刷新访问令牌,确保安全高效地进行数据请求与集成。
263 8
|
10月前
|
人工智能 算法 API
国产化用于单导联和六导联的心电算法及API服务
随着智能设备普及,心电图功能逐渐应用于智能手表、体脂仪等设备。苏州唯理推出单导联及6导联心电算法API服务,由AI驱动,1分钟内快速评估心律失常、房颤、早搏等问题,已广泛用于医疗设备及三甲医院。其算法还可评估压力、疲劳、情绪状态,筛查效率远超进口设备。唯理率先实现国产医疗级心电芯片,支持快速集成与私有化部署,适用于多种智能硬件。
|
数据采集 安全 大数据
Dataphin 5.1:API数据源及管道组件升级,适配多样化认证的API
为提升API数据交互安全性,Dataphin 5.1推出两种新认证方式:基于OAuth 2.0的动态授权与请求签名认证。前者通过短期Access Token确保安全,后者对关键参数加密签名保障数据完整性。功能支持API数据源OAuth 2.0认证和自定义签名配置,未来还将拓展更灵活的认证方式以满足多样化需求。
345 14
|
11月前
|
API
Dataphin功能Tips系列(64)-API资产编目及上架
在企业数据部门中,因API命名不规范、分类不清、信息不全等问题,导致业务开发人员查找困难、重复咨询、误用接口等,影响效率。Dataphin提供API资产编目与上架功能,通过目录规划、属性管理、手动/自动上架等方式,实现API的系统化管理与精准检索,提升业务响应效率。
253 0
|
数据采集 存储 监控
星河中的数据旅程:从普通字段到核心指标 -- 基于Dataphin的数据源资产全链路管理
在数据星河中,Starrocks星球的字段居民渴望登上资产管理平台,贡献数据力量。通过元数据采集、标准稽核与质量监控,字段们获得新身份“核心业务指标”。借助Dataphin平台功能,如自定义属性和QuickBI对接,它们最终参与经营分析报表,助力决策。Dataphin V4.4提升了全链路管理能力,新增大数据存储元数据采集、自定义指标等功能,释放数据潜力。加入Dataphin,探索数据无限可能!
276 8
|
SQL 存储 大数据
Dataphin V5.0:支持创建异步调用API,实现慢 SQL 复杂计算的直连消费
本文介绍了数据服务产品中异步调用的应用场景与优势,包括大数据引擎查询、复杂SQL及大规模数据下载等场景,解决了同步调用可能导致的资源浪费和性能问题。通过创建异步API、测试发布以及权限申请等功能,实现高效稳定的服务提供。以电商订单查询为例,展示了如何利用异步调用提升系统性能与用户体验。
482 9
|
数据采集 SQL 人工智能
告别数据混乱:瓴羊Dataphin 通过AI+标准让企业数据“活”起来 | 【瓴羊数据荟】数据MeetUp第四期
AI技术的快速发展促使企业重新审视数据治理的重要性。当前,企业在数据治理中常因指标口径不统一、数据血缘不透明等问题陷入困境。阿里云智能集团瓴羊高级技术专家周鑫提出,以数据标准为核心贯穿数据全生命周期,可有效解决治理难题。
811 15
告别数据混乱:瓴羊Dataphin 通过AI+标准让企业数据“活”起来 | 【瓴羊数据荟】数据MeetUp第四期

热门文章

最新文章

相关产品

  • 智能数据建设与治理 Dataphin