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

本文涉及的产品
智能数据建设与治理Dataphin,200数据处理单元
简介: 在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】

相关文章
|
3天前
|
数据采集 监控 数据挖掘
常用电商商品数据API接口(item get)概述,数据分析以及上货
电商商品数据API接口(item get)是电商平台上用于提供商品详细信息的接口。这些接口允许开发者或系统以编程方式获取商品的详细信息,包括但不限于商品的标题、价格、库存、图片、销量、规格参数、用户评价等。这些信息对于电商业务来说至关重要,是商品数据分析、价格监控、上货策略制定等工作的基础。
|
21天前
|
API 网络安全
发送UDP数据免费API接口教程
此API用于向指定主机发送UDP数据,支持POST或GET请求。需提供用户ID、密钥、接收IP及端口、数据内容等参数。返回状态码和信息提示。示例中含公共ID与KEY,建议使用个人凭证以提高调用频率。
42 13
|
21天前
|
网络协议 API 网络安全
发送TCP数据免费API接口教程
此API用于向指定主机发送TCP数据,支持POST/GET请求,需提供用户ID、KEY、接收IP、端口及数据内容。返回状态码和信息提示,示例如下:{"code":200,"msg":"发送成功!"}。详情见:https://www.apihz.cn/api/datacstcp.html
35 11
|
1月前
|
人工智能 关系型数据库 MySQL
数据魔力,一触即发 —— Dataphin数据服务API,百炼插件新星降临!
本文通过一个利用百炼大模型平台和Dataphin数据服务API构建一个客户360智能应用的案例,介绍如何使用Dataphin数据服务API在百炼平台创建一个自定义插件,用于智能应用的开发,提升企业智能化应用水平。
128 3
数据魔力,一触即发 —— Dataphin数据服务API,百炼插件新星降临!
|
21天前
|
API 数据安全/隐私保护 开发者
实时获取小红书详情 API 数据
小红书详情API数据获取指南:注册开发者账号,创建应用并申请接口权限,构建请求获取笔记详情,使用Python等语言处理响应数据。需遵守使用规则,注意调用频率和数据安全。
|
1月前
|
XML 数据可视化 API
商品详情数据实战案例,API接口系列
淘宝商品详情数据在电商领域具有广泛的应用价值,而淘宝商品详情API接口则为开发者提供了获取这些数据的重要途径。通过合理利用这些接口和数据,可以提升业务效率、优化用户体验,为电商行业的发展注入新的活力。
|
1月前
|
SQL 缓存 API
在API接口数据获取过程中,如何确保数据的安全性和隐私性?
在API接口数据获取过程中,确保数据的安全性和隐私性至关重要。本文介绍了身份认证与授权、防止SQL注入和XSS攻击、加密传输、API版本控制、限流与熔断、压力测试与性能优化、备份与恢复以及法律和伦理考量等关键措施,帮助开发者和管理者有效保护API接口的数据安全和隐私性。
|
1月前
|
前端开发 JavaScript API
探索GraphQL:如何构建高效的数据API
【10月更文挑战第25天】在现代Web开发中,API的效率和灵活性至关重要。本文探讨了如何利用GraphQL构建高效的数据API。GraphQL通过声明式查询方式,允许客户端精确指定所需数据,减少数据传输量,提高API效率。文章介绍了设置GraphQL服务器、设计API Schema、实现解析函数及调整前后端交互的具体步骤,展示了GraphQL的优势和应用场景。
44 2
|
2月前
|
缓存 监控 测试技术
获取API接口数据的最佳实践详解
在开发过程中,与API进行交互是获取数据和服务的关键步骤。本文详细介绍了10个最佳实践,包括明确需求和文档、错误处理、数据验证、性能优化、安全性、日志和监控、版本控制、代码复用和维护、测试以及遵守法律和道德规范,帮助开发者更高效地从API获取数据,确保数据的准确性、安全性和性能。
|
2月前
|
存储 数据可视化 API
API接口数据获取流程的细化
本文概述了API的基础知识、获取API访问权限的方法、编写代码调用API的步骤、数据处理与分析技巧以及数据安全与合规的重要性,并提供了社交媒体数据分析、天气预报应用和电商数据分析等API数据获取的应用实例,旨在帮助读者全面了解和实践API接口数据获取的流程。

热门文章

最新文章

相关产品

  • 智能数据建设与治理 Dataphin