本文档为您介绍在工业大脑数据工厂控制台中创建API的方法。API服务中定义了常用的数据接口,并提供接口的请求方式、请求地址、请求参数等信息。应用开发者只需根据项目需求,选择所需的数据接口,即可获取对应的接口信息,直接调用接口获取数据。

操作步骤

  1. 进入工业大脑数据工厂控制台,单击数据服务 > 创建API
  2. 填写API信息。
    填写API信息
    输入API名称描述,并选择数据场景,完成后单击下一步
  3. 选择表参数。
    选择表参数
    1. 选择数据源类型,系统支持四种数据源类型:MaxCompute、DataHub、OSS、MySQL。
    2. 选择数据源名称和表名。
      如果数据源名称下拉框为空,说明您还没有在系统中注册过所选类型的云资源,此时可参考添加云资源,将您的云资源注册到系统中进行配置。
      说明 数据源名称下拉框中仅显示您已经添加的云资源的名称,数据源表名下拉框中仅显示所选云资源中存在的数据表的名称。
    3. 设置请求参数返回参数
      数据源配置完成后,系统自动显示所选数据表中的字段的详细信息,包括字段名称字段类型是否分区字段描述。您可以根据需要勾选字段作为请求参数或返回参数,完成后单击下一步
      说明 如果所选数据表中的字段太多,您可以在选择参数搜索框中输入字段名进行搜索,将其设置为请求参数或返回参数,系统支持模糊匹配。
  4. 测试API。
    测试API
    请求参数模块中输入请求参数值,单击API测试
    测试成功后,系统提示API测试成功并显示请求详情返回内容
    请求详情
    返回内容
  5. 单击创建。确认API信息无误后再单击操作栏下的发布,即可将API发布到线上环境,供其他的应用程序调用。
    API发布
    您也可以直接单击创建并发布,一键式创建并发布API。
    注意 只有API测试成功后,系统才支持一键式创建并发布API功能。