自定义SQL模式新建API

系统支持通过SQL语句配置服务单元字段及查询条件生成API。本文为您介绍如何通过自定义SQL模式新建API。

1. 使用开发用户或超级管理员角色的账号，登录Dataphin控制台。
2. 在Dataphin控制台页面，选择工作区地域后，单击进入Dataphin>>。
3. 进入API页面。
   1. 在Dataphin首页，单击顶部菜单栏的服务。
   2. 在服务页面，单击顶部菜单栏的个人后台。
   3. 在个人后台页面，单击左侧导航栏开发中心下的API。
4. 在API页面，单击页面右上角的新建API。
5. 在新建API配置向导页面，完成以下操作。
   1. 选择API的创建方式。
      1. API的创建方式选择为自定义SQL模式。
      2. 单击下一步。
   2. 配置API基础信息。
      1. 配置参数。

         参数	描述
         API名称	API名称由汉字、英文、数字或下划线（_）组合组成。
         请求方式	请求方式包括： GET LIST
         数据更新频率	数据更新频率包括： 每天 每小时 每分钟
         描述	填写对API简单的描述。
         协议	选择通过API同步数据的协议。协议包括： HTTP HTTPS

      2. 单击下一步。
   3. 配置参数。
      1. 在参数配置页面，配置参数。

         编号	参数	描述
         ①	API SQL脚本编辑	在API SQL脚本编辑框中输入SQL语句。 您可以将鼠标悬停至图标，查看SQL脚本的限制。
         ②	服务单元	选择服务单元： 单击服务单元分组显示框区域内，在下拉列表中选择服务单元分组。 单击服务单元类型显示框区域内，在下拉列表中选择服务单元类型。 单击服务单元显示框区域内，在下拉列表中选择服务单元。
         ③	数据预览	单击数据预览，查看服务单元中的数据。
         ④	SQL试运行	查看API SQL脚本的运行结果： 单击SQL运行。 在请求参数输入对话框中，试运行输入值输入为数据预览时获取的user_id的数据。 单击确认，即可开始SQL运行。 如果运行结果返回Success，则SQL语法校验、引擎层校验、底层数据库引擎校验的结果为成功。 如果运行结果返回Error，则SQL语法校验、引擎层校验、底层数据库引擎校验的结果为失败。
         ⑤	解析参数	单击解析参数后，系统根据API SQL脚本编辑处填写的SQL语句自动归类为请求参数和返回参数。
         ⑥	请求参数	配置参数： 单击参数类型显示框区域内，在下拉列表中选择参数类型。 在示例列下的输入框中，输入示例。 在描述列下的输入框中，输入描述。 选择参数为是否必填。
         ⑦	返回参数	配置参数： 单击参数类型显示框区域内，在下拉列表中选择参数类型。 在示例列下的输入框中，输入示例。 在描述列下的输入框中，输入描述。

      2. 单击确定并在预发环境发布，完成API在预发环境的发布。