Skip to content

创建API

创建API是QuickAPI产品中针对数据API模块的主要功能之一。

目前API的创建主要是由三部组成：

1 基础信息填写

此部分的主要是将用户需要针对数据AP填写的基础信息进行完善，主要是和API有关的名称，方法还有一些描述等信息，但业务目录和路径两块的信息是需要提前由系统管理员配置好才能生成的。

具体的图示如下：

2 SQL编写和参数配置

此部分的功能是根据SQL生成相应的数据API。在编写SQL前，先选择相应的数据源信息，接下编写相应的SQL语句，SQL语句支持参数的设置，同时参数设置还支持选填和必填两种，主要是由SQL语句中的和进行的控制，最后还需要将输入参数和输出参数进行相应的配置（此处已经提供了辅助抽取参数的功能辅助用户进参数的抽取，但用户可能还需要根据实际情况进行编辑）。

具体的图示如下：

3 数据API测试

此部分主要是根据以下编写好的SQL进行参数测试，成功后方可以发布相应的数据API，以避免发布一些不可用的数据API。

具体的图示如下：

附加 新建支持修改的数据API（比如更新、插入、删除）

从QuickAPI 1.1.0开始，产品支持针对数据修改的API的生成，和新建查询类数据API基本相关。

不同的点有以下几个方法：

  1. 建议生成修改的数据API选用Post的方式来生成。
  2. 修改数据的情况下，可以使用事务和非事务的方式都是可以的，默认是不开启事务，如果需要开启，在参数传递的时候加上 openTransaction 的参数，并设置为整数 1。