新建脚本式API #

1. 登录 DataLeap租户控制台 。
2. 在右侧快速入口窗口，单击数据服务按钮，可快速进入到数据服务功能界面。
3. 进入到API开发界面，在左侧目录树上单击新建API按钮，在弹窗界面中，选择脚本式API类型。
4. 并按实际情况，填写API相关的基本信息和更多配置，如API名称、存储目录、最大QPS、报警模版等信息。信息配置说明详见“新建API”。
   
5. 信息填写完成后，单击保存按钮，完成脚本式API新建。

配置脚本式API #

脚本式API创建完成后，您便可以选取对应的逻辑表进行API的开发。

1. 下拉选择已创建成功的逻辑表，脚本式创建API，支持选择同源多张逻辑表，最多选择10张。

2. 并在SQL编辑界面，输入业务实际的查询SQL语句。

   说明

   在API设计中，您可以在SQL查询语句中使用LIMIT子句来添加分页功能。其中LIMIT子句需要两个参数：pageNum和pageSize

   • pageNum：表示查询的当前页码；
   • pageSize：表示每页显示的数据条数。

   下面是一个样例，展示了如何在SQL查询语句中配置分页：

   SELECT
       room_id,
       pay_amt,
       product_click_pay_cnt_ratio
   FROM
       room_pay_amt
   WHERE
       product_click_pay_cnt_ratio >= #{product_click_pay_cnt_ratio}
   ORDER BY
       pay_amt DESC
   LIMIT
       #{pageNum}, #{pageSize}
   

   编辑SQL时，全屏编辑实例如下:
   

3. SQL编辑完成后，您可单击“解析”按钮，来自动解析脚本的请求参数信息；单击“运行”按钮，查询成功后，也可自动填充API返回参数信息。

4. 根据实际场景配置API其余高级配置信息。详见“脚本式”。
   脚本式API SQL逻辑和参数配置完成后，您可进行后续的API测试和发布操作。详见“测试API”、“发布API”。