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

相关文章
|
8天前
|
SQL 关系型数据库 MySQL
|
8天前
|
SQL Java 关系型数据库
|
2月前
|
弹性计算 监控 安全
API稳定安全最佳实践:用阿里云SDK为业务保驾护航
阿里云智能集团高级技术专家赵建强和曹佩杰介绍了API稳定安全最佳实践,涵盖业务上云真实案例、集成开发最佳实践、配额管理和共担模型四部分。通过分析企业在不同阶段遇到的问题,如签名报错、异常处理不严谨、扩容失败等,提出了解决方案和工具,确保API调用的安全性和稳定性。特别强调了SDK的使用、无AK方案、自动刷新机制以及配额中心的作用,帮助用户构建更稳定、安全的服务,提升运维效率。最终介绍了集成开发共担模型,旨在通过最佳实践和平台工具,保障业务的稳定与安全,推动行业创新与发展。
|
3月前
|
存储 安全 Java
Spring Boot 编写 API 的 10条最佳实践
本文总结了 10 个编写 Spring Boot API 的最佳实践,包括 RESTful API 设计原则、注解使用、依赖注入、异常处理、数据传输对象(DTO)建模、安全措施、版本控制、文档生成、测试策略以及监控和日志记录。每个实践都配有详细的编码示例和解释,帮助开发者像专业人士一样构建高质量的 API。
127 9
|
3月前
|
监控 数据管理 测试技术
API接口自动化测试深度解析与最佳实践指南
本文详细介绍了API接口自动化测试的重要性、核心概念及实施步骤,强调了从明确测试目标、选择合适工具、编写高质量测试用例到构建稳定测试环境、执行自动化测试、分析测试结果、回归测试及集成CI/CD流程的全过程,旨在为开发者提供一套全面的技术指南,确保API的高质量与稳定性。
|
4月前
|
监控 安全 API
深入浅出:构建高效RESTful API的最佳实践
在数字化时代,API已成为连接不同软件和服务的桥梁。本文将带你深入了解如何设计和维护一个高效、可扩展且安全的RESTful API。我们将从基础概念出发,逐步深入到高级技巧,让你能够掌握创建优质API的关键要素。无论你是初学者还是有经验的开发者,这篇文章都将为你提供实用的指导和启示。让我们一起探索API设计的奥秘,打造出色的后端服务吧!
|
4月前
|
安全 Java API
告别SimpleDateFormat:Java 8日期时间API的最佳实践
在Java开发中,处理日期和时间是一个基本而重要的任务。传统的`SimpleDateFormat`类因其简单易用而被广泛采用,但它存在一些潜在的问题,尤其是在多线程环境下。本文将探讨`SimpleDateFormat`的局限性,并介绍Java 8引入的新的日期时间API,以及如何使用这些新工具来避免潜在的风险。
67 5
|
4月前
|
Web App开发 人工智能 自然语言处理
WebChat:开源的网页内容增强问答 AI 助手,基于 Chrome 扩展的最佳实践开发,支持自定义 API 和本地大模型
WebChat 是一个基于 Chrome 扩展开发的 AI 助手,能够帮助用户理解和分析当前网页的内容,支持自定义 API 和本地大模型。
461 1
|
4月前
|
JSON API 开发者
构建高效API:后端开发中的RESTful最佳实践####
在数字化时代,API作为不同系统间通信的桥梁,其重要性日益凸显。本文将深入探讨RESTful API的设计原则与最佳实践,通过实际案例分析,揭示如何构建高效、可维护且易于使用的API接口,助力后端开发者提升项目质量与用户体验。 ####
|
4月前
|
JavaScript 前端开发 API
探索组合式API与Options API的对比及最佳实践
探索组合式API与Options API的对比及最佳实践

热门文章

最新文章

相关产品

  • 智能数据建设与治理 Dataphin