在您开始新建API前,需要对数据表进行统一的元数据配置,即新建服务单元。本文为您介绍如何基于一张物理表生成服务单元。

前提条件

背景信息

  • 服务单元支持多人协助开发,服务单元列表中展示所有的服务单元。
  • 一个服务单元可以对接多个API,即服务单元与API的关系是1:N。
  • 单物理表服务单元用于基于一张物理表生成服务单元。
  • 服务单元状态说明。
    状态 描述
    草稿 服务单元保存后,即可成为草稿状态。
    开发环境服务中 服务单元提交后,即可进入开发环境中,并且处于服务中的状态。
    生产环境服务中 服务单元发布后,即可进如生产环境中,并且处于服务中的状态。
  • 服务单元支持Basic和Dev-Prod模式。
    模式 使用场景
    Basic 数据生产过程稳定且便捷。数据的开发、提交和发布均调用生产环境的数据。
    Dev-Prod 保障数据安全的同时,满足应用系统的开发需求,提供基于开发数据库的API调用链路。数据的开发和提交均调用开发环境的数据,数据的发布调用生产环境的数据。
  • 管理服务单元的权限限制,请参见数据服务权限列表

操作步骤

  1. 进入个人工作台
  2. 个人工作台页面,单击左侧导航栏的服务单元
  3. 服务单元页面,单击服务单元页面右上角的新建服务单元
  4. 在新建服务单元配置向导页面,完成以下操作。
    1. 服务单元类型选择为单物理表服务单元后,单击下一步
    2. 完成服务单元基础信息配置后,单击下一步
      test
      参数 描述
      服务单元名称 填写服务单元名称。
      服务单元分组 选择服务单元的分组。
      模式 选择开发服务单元的模式。
      物理数据表 选择数据源类型、数据源和数据表。

      您也可以单击新增数据源,新建数据源,详细内容请参见数据源

      服务单元描述 填写对服务单元简单的描述。
      如果系统中服务单元与您选择信息相似,则系统会自动为您展示相似服务单元的名称,同时提供编辑和查看的操作入口。您可以编辑已有的服务单元或单击继续新建
    3. 配置服务单元字段。
      配置服务单元字段页面,您可以修改服务单元字段类型和服务单元字段名称。

      完成服务单元字段的配置后,单击页面下方的数据预览,查看数据。同时您还可以修改返回条数后,单击刷新数据预览后,查看更新后的数据。

  5. 单击提交,完成服务单元创建。
  6. 在服务单元列表页面,鼠标悬停至gaga图标后,单击发布,发布服务单元至生产环境,即可基于服务单元创建API。
    说明 系统仅支持发布已提交的服务单元。
    test
    对已发布的服务单元,可以执行如下操作。
    操作 描述
    编辑 服务单元页面,单击操作列下的fagfa图标,编辑服务单元。
    删除 服务单元页面,单击操作列下的aga图标,删除服务单元。
    说明 仅限服务单元负责人及超级管理员执行删除服务单元的操作。
    查看 服务单元页面,单击操作列下的trst图标,查看开发环境和生产环境中服务单元的详情。
    说明 系统仅支持查看生产环境或开发环境在服务中状态的服务单元。

后续步骤

服务单元发布至生产环境后,即可基于服务单元新建API,请参见模板向导模式新建API自定义SQL模式新建API