场景
在企业的数据部门中,尽管已为多个业务部门开发了涵盖各个场景的数百个API,但因API命名不规范导致定位困难、缺乏业务场景分类以及API信息不补充导致无法快速匹配需求、新业务场景难以快速匹配现有API资源以及历史API未及时清理占用资源等问题,业务开发人员仍面临盲目搜索API、重复咨询技术细节、误用不合规接口等问题,导致支持工作量激增且业务响应延迟。在Dataphin中,我们可以通过以下方式解决这一问题。
解决方案
Dataphin提供API资产编目及上架功能,帮助您系统化管理API,实现资产自助化管理与精准检索,解决API资产分散、此处我们以“会员信息查询”API的编目及上架为例,展示整个流程:
- 在「资产」-「目录规划」-「API目录」,根据会员管理的业务场景,新建资产专题并规划层级目录,搭建清晰的API目录体系,便于业务人员通过目录层级,实现快速查找。
- 「规划」-「属性管理」,为API新建自定义属性,包括管理属性、业务属性等,定义调用需要的关键属性,比如:QPS、API版本、归属业务线等等,便于资产使用人员通过属性进行精准筛选并快速了解API的用途。
- 随后,在「资产」-「手动上架」-「API」-「准资产」处,我们将API的基本信息、以及关键的属性补充完整,同时在使用说明中对API进行更详细的说明。API资产既支持手动上架,也可以配置自动上架规则自动上架。
- 上架成功后,业务人员可以通过资产目录和属性筛选等多种方式,搜索并找到符合需求的API,查看其详细信息、下载API文档。同时点击“申请调用”便可以快速申请该API权限开启调用。