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