Dataphin数据服务系列之--API 配置、管理和消费

最新推荐文章于 2024-06-03 18:02:35 发布

Ta oo

最新推荐文章于 2024-06-03 18:02:35 发布

阅读量982

点赞数

原文链接：https://yq.aliyun.com/articles/726132?utm_content=g_1000088924

版权

作者：张尘初

研发小哥哥还在为公司里大量 API 只上不下，不可查不可用，想找的 API 找不到而苦恼吗？业务方小姐姐还在为 API 开发时间长，业务相应不及时而抱怨吐槽吗？铛铛铛，Dataphin 数据服务 – API 配置管理，闪亮登场！助力研发小哥哥五分钟搞定 API，提升业务响应速度，同时大大提升 API 复用能力！

Dataphin 数据服务
Dataphin 是阿里巴巴数据中台（OneData - OneModel、OneID、OneService）方法论的产品载体。Dataphin 数据服务是其中 OneService 部分的载体，是 Dataphin 产品的组成部分，是数据中台的价值出口。连接数据和业务，主要解决数据最后一公里使用的问题。包括 API 管理、主题式即席查询等能力。本次主要为大家带来数据服务中 API 配置、管理、和使用的相关产品功能介绍~

API 配置 - 五分钟生成 API
配置生成主要有三大步骤：服务单元配置->API 配置->API 测试

服务单元配置
服务单元是数据服务产品中的概念，可以理解为一个逻辑表，可以是下挂单个物理表或下挂多个物理表，也可以是 Dataphin 逻辑表。配置人员根据需要选择字段，并进行字段的相关信息（字段名称和字段类型）配置。下图是单物理表服务单元截图。API 基于服务单元生成。服务单元跟 API 是一对多的关系。
目前数据源类型已支持：MySQL、ElasticSearch、AnalyticDB、HBase，8 月 30 即将支持 PostgreSQL、Oracle、MongoDB。更多数据源持续接入中。

API 配置
基于上文中配置好的服务单元，通过简单的 SQL 脚本，配置 API 的请求参数和返回参数，选择调用方法（支持 GET 和 LIST 两种调用方法），选择 API 更新频率配置，即可快速生成 API。配置界面如下图：

**API 测试 **
API 配置完成后，可以快速进行测试，通过配置请求参数，可以测试 API 的响应时间，以及返回内容详情，等。如下图：

API 管理 - 可上可下可维护

- API 上下线
在 API 管理界面，可以清晰的看到 API 的使用情况，被调用次数，发布更新时间，等。同时可以对新增 API 发布上线，也可以对已经存在的 API 下线和删除。让 API 的管理变得简单。

- API 监控运维
API 生成后，可以进行 API 的监控和运维，包括授权应用数、平均响应时长、调用次数、错误率、offline 百分比等指标的监控。

API 消费 - 好找好拿
API 申请使用主要有三大步骤：API 服务市场查找->API申请和调试->API 使用
- API 服务市场查找
API 市场里包含了企业内所有已经发布的 API 信息，支持按分组查看，支持按 API 名称查找。可以在 API 市场里查看具体 API 的文档详情，也可以直接申请使用 API。

- API 申请调试

  在上文 API 市场中，找到需要的 API 后，点击立即申请即可进入 API 的权限申请界面，入下图。数据服务中 API 的权限管理依托 Dataphin 的公共权限体系能力，做到了 API 字段级别的权限申请管控。当 API 申请通过后，在个人的后台，既可以看到申请通过的 API。通过配置 API 的入参，可以进行 API 调试，获取当前 API 的返回值，查看是否符合预期。API 调试界面可以对焦 API 测试界面，功能相同，多了 appkey 和 secret 传参。

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-Ml9MHGc2-1574326931355)(data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw==)][外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-jkGlsLzp-1574326931356)(data:image/gif;base64,R0lGODlhAQABAPABAP///wAAACH5BAEKAAAALAAAAAABAAEAAAICRAEAOw== “点击并拖拽以移动”)]