数据服务最佳实践(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注册到数据服务平台统一管理运维。

相关文章
|
4天前
|
数据可视化 API 索引
ES常见Index API操作最佳实践!
【10月更文挑战第21天】
21 1
ES常见Index API操作最佳实践!
|
1天前
|
API 数据安全/隐私保护 开发者
探索RESTful API设计的最佳实践
【10月更文挑战第25天】在数字时代的浪潮中,API成为了连接不同软件组件的桥梁。本文将深入探讨如何设计高效的RESTful API,通过实际代码示例揭示背后的逻辑和结构之美。我们将从基础原则出发,逐步展开到高级概念,旨在为读者提供一套完整的设计蓝图。
|
25天前
|
机器学习/深度学习 PyTorch 算法框架/工具
揭秘深度学习中的微调难题:如何运用弹性权重巩固(EWC)策略巧妙应对灾难性遗忘,附带实战代码详解助你轻松掌握技巧
【10月更文挑战第1天】深度学习中,模型微调虽能提升性能,但常导致“灾难性遗忘”,即模型在新任务上训练后遗忘旧知识。本文介绍弹性权重巩固(EWC)方法,通过在损失函数中加入正则项来惩罚对重要参数的更改,从而缓解此问题。提供了一个基于PyTorch的实现示例,展示如何在训练过程中引入EWC损失,适用于终身学习和在线学习等场景。
41 4
揭秘深度学习中的微调难题:如何运用弹性权重巩固(EWC)策略巧妙应对灾难性遗忘,附带实战代码详解助你轻松掌握技巧
|
6天前
|
缓存 监控 测试技术
获取API接口数据的最佳实践详解
在开发过程中,与API进行交互是获取数据和服务的关键步骤。本文详细介绍了10个最佳实践,包括明确需求和文档、错误处理、数据验证、性能优化、安全性、日志和监控、版本控制、代码复用和维护、测试以及遵守法律和道德规范,帮助开发者更高效地从API获取数据,确保数据的准确性、安全性和性能。
|
23天前
|
开发框架 .NET API
Windows Forms应用程序中集成一个ASP.NET API服务
Windows Forms应用程序中集成一个ASP.NET API服务
77 9
|
24天前
|
存储 缓存 API
构建高效后端:RESTful API 设计的最佳实践
【10月更文挑战第2天】在数字化时代,后端开发是连接用户与数据的桥梁。本文将深入探讨如何设计一个高效、易于维护的后端系统,特别是围绕RESTful API的设计原则和最佳实践。我们将从基础概念出发,逐步深入到实际案例分析,最终通过代码示例具体展示如何实现这些设计原则。无论你是初学者还是有经验的开发者,这篇文章都将为你提供价值,帮助你构建更优秀的后端服务。
57 10
|
17天前
|
XML JSON API
深入理解RESTful API设计:最佳实践与实现
【10月更文挑战第9天】深入理解RESTful API设计:最佳实践与实现
30 1
|
26天前
|
存储 缓存 中间件
构建高效RESTful API:最佳实践与技巧
构建高效RESTful API:最佳实践与技巧
|
1月前
|
安全 测试技术 API
后端开发中的API设计原则与最佳实践
本文将深入探讨在后端开发中API(应用程序编程接口)设计的基本原则和最佳实践。通过阐述如何构建高效、可扩展且安全的API,帮助开发者提升后端系统的性能和用户体验。不同于传统的摘要,本文无需包含背景介绍,直接进入主题,为读者提供实用的指导。
47 7
|
1月前
|
API 开发者 UED
构建高效RESTful API的最佳实践
【9月更文挑战第33天】在数字化时代,后端开发不仅仅是关于代码的编写。它是一场架构艺术的演绎,是性能与可维护性之间的舞蹈。本文将带你深入理解RESTful API设计的精髓,探索如何通过最佳实践提升API的效率和可用性,最终实现后端服务的优雅蜕变。我们将从基础原则出发,逐步揭示高效API设计背后的哲学,并以实际代码示例为路标,指引你走向更优的后端开发之路。

热门文章

最新文章

相关产品

  • 智能数据建设与治理 Dataphin