Skip to main content

D2A

D2A (Database to API) 是平台提供的一种通过HTTP API的形式将关系型数据的读写操作开放出来的快捷开发方式。目前系统支持的关系型数据源类型包括:MySQL、Oracle、PostgreSQL、DB2、SQL Server等。

D2A创建流程

  1. 在数据源标签页下创建数据源

    新建数据源时输入相应的信息之后会进行连接测试,测试成功后点击保存按钮,就成功完成了数据源的创建。

    数据源管理列表页中你可以当前的数据源都有哪些,每个数据源的类型,以及它下面是不是绑定有API。如果想删除一个数据源必须保证当前数据源下没有被绑定的API。

  2. 在D2A应用管理标签页上点击【添加D2A应用】按钮,并输入名称和描述等信息新增一个D2A应用。

  3. 点击应用的名字进入编辑页面,点击新建按钮来创建D2A API。

    选择一种D2A模式:

    • 普通模式支持通过可视化方式进行编辑,适用于简单的单表CURD操作。

    • 高级模式下用户可以通过手写SQL语句的方式进行编辑,适用于复杂的数据查询场景。

      注意:点击下一步之后将不能再更改模式

      选择数据源。如果您之前已经创建了数据源,可以从下拉列表中选中它,如果之前没有创建过任何数据源,可以通过右上角的新建数据源按钮去创建数据源。

      点击下一步,进入API配置页面(下图为普通模式创建页面为例)。

      如果选择高级模式,在SQL模板中如果需要传入动态API参数,则需要使用 {参数位置:参数名} 的方式(请确保参数已经定义),参数位置允许为 query, header, path 中一种,比如:

      SELECT * FROM TEST_TABLE WHERE ID='{query:id}'

    API配置完成之后,点击完成按钮会回到这个应用的列表页,你可以在这个页面了解到当前应用下有多少个API,可以对某一个API进行编辑或删除的操作。也可以继续在当前应用下新建API。

注意事项:

  1. 如果要删除掉一个已有的D2A应用,需要在这里先将该应用下的所有API全部删除,之后才能成功删除这个应用。
  2. 如果将D2A API删除,则已经注册到项目中的API会即可失效。
  3. 为了避免返回数据过大导致性能问题,高级模式中最多返回500条数据,如需分页请在SQL模板中自行实现。