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

相关文章
|
9天前
|
人工智能 关系型数据库 MySQL
数据魔力,一触即发 —— Dataphin数据服务API,百炼插件新星降临!
本文通过一个利用百炼大模型平台和Dataphin数据服务API构建一个客户360智能应用的案例,介绍如何使用Dataphin数据服务API在百炼平台创建一个自定义插件,用于智能应用的开发,提升企业智能化应用水平。
数据魔力,一触即发 —— Dataphin数据服务API,百炼插件新星降临!
|
1月前
|
开发框架 .NET API
Windows Forms应用程序中集成一个ASP.NET API服务
Windows Forms应用程序中集成一个ASP.NET API服务
90 9
|
2月前
|
人工智能 Serverless API
一键服务化:从魔搭开源模型到OpenAI API服务
在多样化大模型的背后,OpenAI得益于在领域的先发优势,其API接口今天也成为了业界的一个事实标准。
一键服务化:从魔搭开源模型到OpenAI API服务
|
2月前
|
API 搜索推荐
|
2月前
|
Go API 开发者
深入探讨:使用Go语言构建高性能RESTful API服务
在本文中,我们将探索Go语言在构建高效、可靠的RESTful API服务中的独特优势。通过实际案例分析,我们将展示Go如何通过其并发模型、简洁的语法和内置的http包,成为现代后端服务开发的有力工具。
|
2月前
|
SQL 分布式计算 BI
Dataphin中集成SelectDB以支持报表分析和API查询
本文介绍了一家零售企业如何利用SelectDB进行BI分析及数据服务API的查询。通过Dataphin的数据集成、SQL研发等功能,将CRM、ERP等系统数据汇聚加工,并推送至SelectDB构建销售数据集市层,以支持报表分析及API查询。SelectDB具备实时、统一、弹性及开放特性,适用于多种实时分析场景。文章详细描述了在Dataphin中集成SelectDB的整体方案、数据源配置、数据集成、数据开发及数据服务流程。
116 0
|
3月前
|
JavaScript 安全 API
构建高效后端服务:RESTful API 设计与实现
【8月更文挑战第31天】在数字化时代,一个清晰、高效且安全的后端服务是应用程序成功的关键。本文将深入探讨如何设计并实现一个遵循REST原则的API,确保服务的可扩展性和维护性。我们将从基础概念出发,逐步引入真实代码示例,展示如何利用现代技术栈创建高性能的后端服务。无论你是初学者还是有经验的开发者,这篇文章都将为你提供新的视角和实用的技巧。
|
3月前
|
API Java Python
API的神秘面纱:从零开始构建你的RESTful服务
【8月更文挑战第31天】在现代网络应用开发中,RESTful API已成为数据交互的标准。本文通过比较流行的技术栈(如Node.js、Python的Django和Flask、Java的Spring Boot)及其框架,帮助你理解构建RESTful API的关键差异,涵盖性能、可扩展性、开发效率、社区支持、安全性和维护性等方面,并提供示例代码和最佳实践,指导你选择最适合项目需求的工具,构建高效、安全且易维护的API服务。
57 0
|
3月前
|
Java 缓存 数据库连接
揭秘!Struts 2性能翻倍的秘诀:不可思议的优化技巧大公开
【8月更文挑战第31天】《Struts 2性能优化技巧》介绍了提升Struts 2 Web应用响应速度的关键策略,包括减少配置开销、优化Action处理、合理使用拦截器、精简标签库使用、改进数据访问方式、利用缓存机制以及浏览器与网络层面的优化。通过实施这些技巧,如懒加载配置、异步请求处理、高效数据库连接管理和启用GZIP压缩等,可显著提高应用性能,为用户提供更快的体验。性能优化需根据实际场景持续调整。
74 0
|
3月前
|
JSON API 数据库
探索FastAPI:不仅仅是一个Python Web框架,更是助力开发者高效构建现代化RESTful API服务的神器——从环境搭建到CRUD应用实战全面解析
【8月更文挑战第31天】FastAPI 是一个基于 Python 3.6+ 类型提示标准的现代 Web 框架,以其高性能、易用性和现代化设计而备受青睐。本文通过示例介绍了 FastAPI 的优势及其在构建高效 Web 应用中的强大功能。首先,通过安装 FastAPI 和 Uvicorn 并创建简单的“Hello, World!”应用入门;接着展示了如何处理路径参数和查询参数,并利用类型提示进行数据验证和转换。
95 0

相关产品

  • 智能数据建设与治理 Dataphin