数据服务最佳实践(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】

相关文章
|
8月前
|
JSON 缓存 算法
如何通过API获取1688商品类目数据:技术实现指南
1688开放平台提供alibaba.category.get接口,支持获取全量商品类目树。RESTful架构,返回JSON数据,含类目ID、名称、层级等信息。需注册账号、创建应用并授权。请求需签名认证,QPS限10次,建议缓存更新周期≥24小时。
|
8月前
|
JSON 安全 API
亚马逊商品列表API秘籍!轻松获取商品列表数据
亚马逊商品列表API(SP-API)提供标准化接口,支持通过关键词、分类、价格等条件搜索商品,获取ASIN、价格、销量等信息。采用OAuth 2.0认证与AWS签名,保障安全。数据以JSON格式传输,便于开发者批量获取与分析。
|
8月前
|
JSON 监控 API
小红书笔记评论API:一键获取分层评论与用户互动数据
小红书笔记评论API可获取指定笔记的评论详情,包括内容、点赞数、评论者信息等,支持分页与身份认证,返回JSON格式数据,适用于舆情监控、用户行为分析等场景。
1220 1
|
9月前
|
供应链 监控 安全
1688商品详情API接口实战指南:合规获取数据,驱动B2B业务增长
1688商品详情API(alibaba.product.get)是合规获取B2B商品数据的核心工具,支持全维度信息调用,助力企业实现智能选品、供应链优化与市场洞察,推动数字化转型。
|
8月前
|
数据采集 JSON API
微店API使用指南:高效获取商品列表数据
本文介绍如何使用Python爬虫调用微店item_search接口,根据关键词搜索商品并获取商品列表数据,涵盖请求方式、JSON数据解析、分页参数设置及筛选排序功能,适用于电商数据分析与竞品研究。
|
8月前
|
JSON API 数据格式
淘宝拍立淘按图搜索API系列,json数据返回
淘宝拍立淘按图搜索API系列通过图像识别技术实现商品搜索功能,调用后返回的JSON数据包含商品标题、图片链接、价格、销量、相似度评分等核心字段,支持分页和详细商品信息展示。以下是该API接口返回的JSON数据示例及详细解析:
|
8月前
|
JSON 算法 API
Python采集淘宝商品评论API接口及JSON数据返回全程指南
Python采集淘宝商品评论API接口及JSON数据返回全程指南
|
8月前
|
自然语言处理 算法 数据可视化
看球总刷比分?好奇数据哪来的?你该认识一下「体育API」了
体育API是赛事数据的“幕后搬运工”,实时同步比分、赛程、球员统计等信息,支撑各类应用提供精准推送、深度分析与互动体验,让观赛更智能高效。
566 150
|
8月前
|
JSON API 数据安全/隐私保护
Python采集淘宝拍立淘按图搜索API接口及JSON数据返回全流程指南
通过以上流程,可实现淘宝拍立淘按图搜索的完整调用链路,并获取结构化的JSON商品数据,支撑电商比价、智能推荐等业务场景。
|
9月前
|
JSON 前端开发 API
如何调用体育数据足篮接口API
本文介绍如何调用体育数据API:首先选择可靠服务商并注册获取密钥,接着阅读文档了解基础URL、端点、参数及请求头,然后使用Python等语言发送请求、解析JSON数据,最后将数据应用于Web、App或分析场景,同时注意密钥安全、速率限制与错误处理。
918 152

热门文章

最新文章

相关产品

  • 智能数据建设与治理 Dataphin