You need to enable JavaScript to run this app.
导航

API集市

最近更新时间2023.09.28 14:16:19

首次发布时间2023.09.28 14:16:19

API集市模块主要用来解决API开发过程中重复开发、滥用数据等问题,目标是提高API的使用,最大程度的实现API的复用,减少冗余开发。

1 适用场景

  • 场景一 :当您想跨项目使用某个API时,可以通过API集市申请权限。

  • 场景二 :当您知道自己需要什么类型的API时,可以通过API集市进行搜索与查看,找到最终需要的API。

2 上架流程

API需先上架,才可在市场展示,提供给用户查看和使用。上架流程如下:

3 前提条件

  1. 已设置好相应项目下API的上架逻辑,详细说明请参见项目管理

  2. 在该项目下,已创建API并上架至API市场。相关说明请参见API开发

4 操作步骤

  1. 登录 DataLeap 控制台。

  2. 选择概览 > 数据服务 > 数据集市 > API集市,进入API集市页面。

  3. 可以查看已上架API的信息,并执行以下操作:

    • 设置搜索信息,搜索符合条件的API列表。

    • 单击某条API信息,进入详情页面,可查看其详情信息并申请调用。

      • 可以查看并管理API的调用信息、授权管理、报警配置、调用监控、API测试等功能信息,相关操作说明可参见API开发

      • 单击申请调用按钮,在弹出的侧拉窗口中,设置调用信息后,单击确定按钮提交申请。

        申请调用API的相关参数说明如下表所示。其中名称前带 * 的参数为必填参数,名称前未带 * 的参数为可选参数。

        参数说明
        基本权限

        *应用名称

        申请调用应用的名称,下拉可选已创建的应用。
        若没有合适的选项,可通过下拉列表中的新建应用按钮,跳转到添加应用页面,创建新的应用。

        标志符应用的唯一标识。选择应用名称后,自动显示。

        最大QPS

        每秒最大调用次数,可输入当前应用预估最大QPS。

        说明

        应用调用API的QPS达到设置值时,会触发限流;如不填写或填写0,则默认不限流。

        有效期

        应用授权的有效期,支持永久、1天、7天、30天、90天、180天、365天,默认为永久,下拉可选其他。

        说明

        新的到期时间=当前到期时间+续期天数,续期时会给API管理者和应用的申请者发送通知。

        *申请原因申请调用的原因,长度为100个字符以内。
        行列权限

        行级权限

        可选择是否开启行级权限开关。
        若开启,则针对请求参数做限制,比如限制只能访问某参数的某几个值。

        列权限

        可选择是否开启列权限开关。
        若开启,则针对返回参数做限制,比如限制只能返回某列返回参数。