更新时间:2024-05-06 GMT+08:00
分享

开发 API

  • 创建API
    1. 进入“数据服务>API目录”页面,单击加号,输入新建API目录名称,可新建API目录。对应已成功创建的API目录的操作列,可重新编辑API目录或者管理API。
      图1 创建API1
    2. 单击“编辑”,可修改API目录名称信息。仅当API处于已创建、已驳回、已下线、已停用的情况下才能进行API修改。
      图2 创建API2
    3. 进入“API管理”页面,单击“新建”,填写API基本信息。
      图3 创建API3
    4. 配置好API基本信息后,单击“下一步”,即可进入API取数逻辑页面。
      图4 创建API4
    5. 选择数据源、数据连接、数据库和数据表,获取到需要配置的表。
      图5 创建API5
    6. 配置参数字段选择好数据表之后,单击“参数设置”后的“添加”,添加参数页面自动列出这个表的所有字段,分别勾选需要设置为请求参数、返回参数和排序参数的字段,分别添加到请求参数、返回参数和排序参数列表当中。
  • 调试API
    1. 单击“开发API > API管理”,进入到API管理信息页面。
      图6 调试API1
    2. 单击“API名称”,进入API详情页面,单击“调试”。 或者在待调试的API所在行,单击“更多 > 调试”。
      图7 调试API2
    3. 添加请求参数后,单击“开始测试”。右侧返回结果回显区域打印API调用的Response信息。调用成功时,返回HTTP状态码为“200”和Response信息。调试失败时,返回HTTP状态码为4xx或5xx。
      图8 调试API3
    4. 可以通过调整请求参数与参数值,发送不同的请求,验证API服务。
  • 发布API

    进入“数据服务>总览>开发API>API管理”页面,在API服务列表操作列中,选择“更多>发布”。

    图9 发布API

相关文档