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

本文涉及的产品
智能数据建设与治理Dataphin,200数据处理单元
简介: 在DataphinV3.11版本中,我们支持了注册外部API的能力,用于支持客户统一管理企业所有的API,打造企业的数据服务中心。API注册到Dataphin之后,可以由Dataphin统一纳管,和其他方式创建的API共用相同的服务市场、权限管控、运维监控能力。同时我们支持了Json文本解析能力,支持编写类似正则表达式的语法定义注册API返回参数的取值路径,满足企业自定义取数的场景。

在DataphinV3.11版本中,我们支持了注册外部API的能力,用于支持客户统一管理企业所有的API,打造企业的数据服务中心。API注册到Dataphin之后,可以由Dataphin统一纳管,和其他方式创建的API共用相同的服务市场、权限管控、运维监控能力。

同时我们支持了Json文本解析能力,支持编写类似正则表达式的语法定义注册API返回参数的取值路径,满足企业自定义取数的场景。


一、场景介绍

场景1:企业一些算法服务,无法仅通过编写SQL完成开发,就需要企业开发人员通过编写代码来开发API,将开发好的API注册到dataphin平台的数据服务,实现对企业所有API的统一管理和监控。

例如:网约车行业的一些算法服务(例如获取最优线路),需要通过python语法,在指定的机器学习框架(如TensorFlow)下开发好算法模型,最后再封装成算法服务对外调用。像这种算法服务无法通过简单的SQL实现的,需要企业的开发人员完成算法模型开发并封装成算法服务后才能使用的,则可以把算法服务直接注册到dataphin平台的数据服务,由数据服务统一管理和监控算法服务的调用。


场景2:客户现有系统已有一些接口,想通过dataphin的服务运维监控功能和鉴权功能,把这些API进行管起来,在调用注册API时,向dataphin发起请求,dataphin再从原接口进行请求数据,实现对已有接口的监控。

例如:企业的一些系统有对外开放的OpenAPI,企业希望对这些OpenAPI的调用进行运维监控。那么可以将这些OpenAPI注册到数据服务,利用数据服务原有的运维监控功能实现OpenAPI的限流、告警、调用统计、调用日志查看等功能。


二、API注册能力介绍

1.1 配置API数据源

先到【管理中心】->【数据源管理】->【新建数据源】数据源的类型选择:半结构化存储->API,创建API数据源。这里仅需要配置后端服务的根路径/域名,以及鉴权信息。

1.2、注册外部API

可以在新建API的时候,选择注册API的方式创建API

配置时,需要先选择一个具体的API数据源,然后服务path配置具体的调用路径(即相对路径),系统会组合成完整的转发调用路径。

1.3 配置注册API的参数信息

请求参数:支持定义请求参数的位置和默认值。

返回参数:支持定义返回参数取值路径,通过编写类似正则表达式的语法来指定提取后端服务返回的Json文档内容,满足各种取数场景。

通过以上三步就可以将外部的API注册到Dataphin中,使用Dataphin进行统一的管理。


三、视频操作手册

通过Dataphin实现API注册的完整流程,可以参考操作视频:


四、结语

支持注册外部API后,企业可以将已开发好的API注册到数据服务平台统一管理运维,对外统一由数据服务平台提供API申请、API鉴权调用、API运维等功能,让企业可以更专注于服务的开发。

建议升级到3.11的新版本之后,用户可以结合企业的实际业务诉求和新的产品能力,将外部API注册到数据服务平台统一管理运维。

相关文章
|
2天前
|
SQL 分布式计算 DataWorks
Dataphin常见问题之补数据任务卡着不动如何解决
Dataphin是阿里云提供的一站式数据处理服务,旨在帮助企业构建一体化的智能数据处理平台。Dataphin整合了数据建模、数据处理、数据开发、数据服务等多个功能,支持企业更高效地进行数据治理和分析。
|
23小时前
|
存储 缓存 JSON
第九篇 API设计原则与最佳实践
第九篇 API设计原则与最佳实践
|
2天前
|
缓存 测试技术 API
RESTful API的最佳实践
【5月更文挑战第11天】在Python中构建RESTful API时,可以选择轻量级的Flask或全栈的Django框架。Flask适用于小型到中型API,而Django适合大型复杂项目。示例代码展示了如何在两个框架中创建任务列表API。
16 0
|
2天前
|
缓存 监控 JavaScript
Node.js中构建RESTful API的最佳实践
【4月更文挑战第30天】本文介绍了在Node.js中构建RESTful API的最佳实践:选择合适的框架(如Express、Koa)、设计清晰的API接口(遵循HTTP动词和资源路径)、实现认证授权(JWT、OAuth 2.0)、错误处理、限流缓存、编写文档和测试,以及监控性能优化。这些实践有助于创建健壮、可维护和易用的API。
|
2天前
|
数据采集 DataWorks 安全
DataWorks产品使用合集之在DataWorks数据服务中,生成API和注册API的主要区别如何解决
DataWorks作为一站式的数据开发与治理平台,提供了从数据采集、清洗、开发、调度、服务化、质量监控到安全管理的全套解决方案,帮助企业构建高效、规范、安全的大数据处理体系。以下是对DataWorks产品使用合集的概述,涵盖数据处理的各个环节。
29 2
|
2天前
|
缓存 监控 API
|
2天前
|
缓存 JSON 负载均衡
构建高效RESTful API的最佳实践
【4月更文挑战第22天】在当今互联网应用的开发中,后端系统的核心通常体现在API的设计和实现上。一个设计良好、性能优异的RESTful API能够极大地提升应用的响应速度及用户体验。本文将探讨在构建高效RESTful API时应当遵循的一系列最佳实践,包括合理的数据结构设计、缓存策略、负载均衡技术以及API版本管理等。通过这些实践,可以确保API服务的高性能与易维护性,并适应不断变化的业务需求。
|
2天前
|
缓存 负载均衡 NoSQL
构建高效可扩展的RESTful API:后端开发的最佳实践
【4月更文挑战第14天】在当今快速发展的网络应用时代,一个结构良好且高效的RESTful API是确保后端服务可靠性和性能的关键。本文深入探讨了设计和实现高效可扩展RESTful API的最佳实践,涵盖了API设计原则、数据库优化、缓存策略以及负载均衡等关键方面。文中不仅提供了具体的技术建议,还通过案例分析展示了如何应对实际开发中的挑战。
|
2天前
|
缓存 安全 API
构建高效RESTful API的最佳实践
【4月更文挑战第4天】 随着移动和Web应用的兴起,RESTful API已成为前后端交互的重要桥梁。本文将深入探讨如何构建一个既符合REST原则又具有高性能的API服务。我们将从API设计原则出发,讨论资源划分、HTTP方法使用、状态码表达、缓存策略、版本控制及安全措施等关键方面。同时,将提供实用的编码技巧和工具选择建议,帮助开发者提升API的性能和可维护性。
|
2天前
|
Linux API 网络架构
Rest API请求管理最佳实践:RestClient-cpp库的应用案例
Rest API请求管理最佳实践:RestClient-cpp库的应用案例

热门文章

最新文章

相关产品

  • 智能数据建设与治理 Dataphin