数据共享交换平台之API服务开发、挂载、申请审核

Question

龙石数据中台提供了完整的API服务开发、挂载、申请审核全生命周期管理能力，旨在将数据安全、高效地共享给内外部应用。整个过程可以概括为：开发API服务 -> 将API挂载到资源目录 -> 用户申请 -> 管理员审核授权。

这是创建可共享数据API的核心步骤，平台提供了多种开发方式。

自助API开发（可视化、无代码）
- 功能概述：针对查询类API，提供可视化、无代码的开发界面，自动生成API文档和返回示例。
- 操作路径：数据共享 -> API共享 -> API管理 -> 自助API。
- 核心流程：
  - 在可视化界面配置API的基本信息（名称、路径等）、输入参数、返回参数。
  - 系统自动生成API文档和返回示例。
  - 支持对返回数据进行深度处理，如格式转换、脱敏、截取、值映射、加密解密、分页等。
编排API开发（复杂服务聚合）
- 功能概述：对于需要组合多个步骤或数据源的复杂API，提供Web可视化编排能力。
- 操作路径：数据共享 -> API共享 -> API管理 -> 编排API维护。
- 核心能力：通过拖拽内置组件（如Restful API、WebService、表查询、数据转换等），实现多协议转换、服务聚合和复杂逻辑编排。
穿透API（外部API接入）
- 功能概述：将已有的第三方API接入平台进行统一纳管。
- 核心能力：支持地址转换和标准化，对外提供统一的调用地址和规范；支持批量导入返回参数说明。

API开发完成后，需将其与数据资产目录中的具体资源进行关联，使其成为可被发现和申请的数据服务。

挂载方式
- 路径：数据资产 -> 资源挂载管理。
- 操作：在对应资源目录的详情页，选择“挂载API”。
- 两种挂载场景：
  - 挂载外部API：直接填写已存在的第三方API信息（名称、地址、请求方法等）。
  - 挂载平台API：点击“基于库表开发接口”，系统会跳转至API管理模块，引导您创建API。创建后返回挂载页面，点击“从API平台获取”，通过关键词检索并关联刚创建的API。
挂载效果：成功挂载后，API的基本信息、请求头、请求参数、返回参数及示例等信息将自动关联到资源目录中，供申请者查阅。

用户通过大数据门户发现所需API资源后，发起申请，由管理员进行审核授权，确保数据共享安全可控。

用户申请（在门户侧）
- 操作：用户在大数据门户的资源目录中找到目标API资源，点击“申请使用”。
- 填写信息：用户需填写申请用途、使用期限等必要信息，提交申请工单。
管理员审核（在中台管理侧）
- 操作路径：数据资产 -> 资源申请审核。
- 审核内容：管理员对用户提交的申请信息（完整性、准确性、资源需求合理性）进行综合判断。
- 审核结果：
  - 审核通过：系统生成调用码（AppKey/AppSecret），用户可使用该凭证调用API。
  - 审核驳回：说明理由后退回给申请人修改。
API授权与安全（精细化管控）
- API授权：在 API共享 -> API授权 中，管理员可将调用码与具体的调用场景绑定，实现细粒度授权。
- 白名单/黑名单：在 API共享 -> 白名单/黑名单 中，可设置可信IP白名单（允许直接访问）或限制非法访问的黑名单，保障调用来源安全。
- 鉴权机制：平台支持基于行业通用的公私钥调用机制进行鉴权，保障API调用过程的安全。

整个API服务从开发到使用的闭环流程如下：

通过以上流程，龙石数据中台实现了API服务的标准化开发、规范化挂载、流程化申请、安全化授权的全生命周期管理，有效解决了数据“共享难、获取难”的痛点。