推荐一款用于自动生成API接口的开源工具DBAPI，用于数仓业务应用提供接口工具，简单高效。

介绍
狭义上说，DBAPI是一个面向数仓开发人员的低代码工具，只需在页面上编写sql，并配置好参数，就可以自动生成http接口。它可以帮助程序员快速的开发后端数据接口，尤其适用于BI报表、数据可视化大屏的后端接口开发。

广义上说，DBAPI是整个企业数据接口的管理中心，是企业对外提供数据服务的管理平台。它提供了数据接口的动态创建发布功能，对接口的统一管理，并提供了对客户端的管理能力，可以监控客户端对接口的调用、控制客户端对接口的权限。

标题特点

开箱即用，不需要编程，单机模式不需要依赖其他软件（只需要java运行环境）
支持单机模式、集群模式；支持云原生容器化部署
支持动态创建、修改API；动态创建、修改数据源。热部署全程无感。
支持API级别的访问权限控制，支持IP白名单、黑名单控制
支持所有类型数据库（JDBC协议），包括mysql/sqlserver/postgreSql/hive/oracle等等
支持动态sql，类似mybatis的动态sql，支持sql编辑、运行、调试
丰富的插件扩展，支持缓存、数据转换、失败告警
支持API配置导入导出，方便测试环境到生产环境的API迁移
支持一个接口内多条SQL执行（例如分页功能），支持事务开启关闭
支持application/json和application/x-www-form-urlencoded
支持接口调用记录查询，接口访问信息统计
#视频教程
视频教程(opens new window)

标题基本操作

标题创建/修改数据源

标题#创建/修改API

标题基础配置

API分组，选择API所属的分组，这个分组可以将来授权使用
请求路径，这就是将来http请求的路径
选择数据源，就是接口执行sql逻辑的数据库地址
填入sql ,类似mybatis的动态sql语法，不需要写最外层的 标签，参数名用 #{} ${} 表示，可以参考mybatis文档(opens new window)
一个sql编写窗口内只能写一条sql
点击添加可以新增sql，一个API内可以执行多条sql，最后的多个结果封装后一起返回，比如分页查询，一个接口内既要查询详情也要查询总条数
选择Content-Type，如果是application/x-www-form-urlencoded类型的API, 需要配置参数，如果是application/json类型的API，需要填写json参数实例
对于application/x-www-form-urlencoded类型的API，用户在请求该API的时候既可以使用application/x-www-form-urlencoded，也可以使用application/json

对于application/json类型的API，用户在请求该API的时候只能使用application/json方式

添加参数，参数名称就是sql中的参数名，sql中涉及到的每个参数都要填写
访问权限，开放接口可以直接访问，私有接口需要用户申请token才能访问

标题高级配置

事务
默认关闭事务，如果是insert/update/delete语句，建议开启事务，开启事务后如果sql执行失败事务会回滚。如果API内有多条sql，开启事务后多条sql是放在一个事务内执行的

如果是HIVE等不支持事务的数据库，请不要开启事务，否则会报错

数据转换，如果需要数据转换，就填写数据转换插件的java类名，不填写表示不转换。插件如果需要传参数就填写参数。
如果一个API内包含多条sql，那么每条sql会对应一个数据转换插件配置，数据转换插件永远是针对单条sql查询结果进行转换

缓存，如果需要数据缓存，就填写缓存插件的java类名，不填写表示不开启缓存。插件如果需要传参数就填写参数。
告警，如果API执行失败需要告警的话，就填写告警插件的java类名，不填写表示不开启失败告警。插件如果需要传参数就填写参数。

标题API分组管理

可以添加、删除分组

标题API请求测试

在页面快速访问API，查看结果

如果是私有接口，用户必须先使用自己的appid和secret来申请token，然后再使用token去访问接口。 如果是开放接口则可以直接访问

注意如果是内网部署，您需要手动修改访问的IP、端口为外网IP、端口

标题sql调试

点击sql填写框右上角的最大化按钮，可以开启sql调试功能
如果sql中有参数，在调试的时候，请输入参数

标题权限管理

什么是应用？

应用由系统管理员创建，创建好后会自动生成appid和secret，系统管理员需要将appid和secret告知客户端（API调用方）。 客户端使用自己的appid和secret访问 http://192.168.xx.xx:8520/token/generate?appid=xxx&secret=xxx 接口可以动态的获取token，客户端使用这个token才能访问私有API（前提是系统管理员已经对该应用授权了访问此私有API）

标题创建应用

创建应用必须设置token过期时间，以后客户端每次申请的token就会有相应的过期时间，在这个有效期内， 使用上一次申请的token去访问API都是有效的。否则过了这个过期时间，就要重新申请token。

如果token过期时间设置单次有效，那么每次访问私有API都需要重新申请一次token

标题授权应用可以访问哪些API

私有API权限控制粒度仅到API分组级别，可以对应用授权可以访问那些分组下的API。 那么该应用对应的apid和secret申请到的token就可以访问到该应用授权的分组下的API

标题Token使用说明

token申请接口： http://192.168.xx.xx:8520/token/generate?appid=xxx&secret=xxx

请求私有接口时，需要把token值放入header的Authorization字段中携带，才可以访问成功。（如果是开放接口，不需要设置header）

以python为例，访问API的代码示例如下：

import requests
headers = {"Authorization": "5ad0dcb4eb03d3b0b7e4b82ae0ba433f"}
re = requests.post("http://127.0.0.1:8520/API/userById", {"idList": [1, 2]}, headers=headers)
print(re.text)

标题ip防火墙设置

标题监控

DBAPI只依赖元数据库（mysql/sqlite）就可以使用，但是如果您还需要使用页面上的监控功能（监控API调用记录、访问量、成功率等等）， 就必须依赖于另一个日志数据库（需用户自行搭建），来存储API访问日志，推荐使用clickhouse，当然您也可以使用其它的关系型数据库。

目前提供了clickhouse/mysql的日志数据库初始化脚本，在sql目录下

API访问日志采集进入日志数据库有3种方式
DBAPI默认会将API访问日志写入磁盘文件logs/dbapi-access.log，用户可以自行使用datax flume等工具采集日志到日志数据库。
如果在conf/application.properties文件配置了access.log.writer=db，那么DBAPI会将API访问日志直接写入日志数据库，这种方式适用于日志量不太大的场景下。
如果在conf/application.properties文件配置了access.log.writer=kafka，那么DBAPI会将API访问日志写入kafka， 用户需要自行从kafka采集日志到日志数据库，这种方式适用于日志量大的场景，可以由kafka去做数据缓冲。
注意此种方式下需要在conf/application.properties文件填写kafka地址。

同时DBAPI也自带了消费kafka日志并写入日志数据库的工具，请使用XXX脚本。

如果您不需要使用监控功能，可以不用搭建日志数据库，并配置access.log.writer=null即可。

标题Dashboard

标题导出接口文档

可以导出接口文档（markdown格式）

标题数据源

理论上支持所有支持JDBC协议的数据库
创建数据源的时候如果选择其他类型，需要用户手动填写JDBC驱动class类和查询所有表的sql，同时将相应的JDBC驱动jar包放入DBApi的lib目录下并重启生效（如果是集群模式，每个节点都需要拷贝jar包并重启集群）
DBApi已经自带mysql/sqlserver/postgreSql/hive/kylin/clickhouse/的驱动包，如果版本不匹配请手动替换lib目录下的相应驱动jar包
查询所有表sql的作用：创建、编辑API的时候，点击选择数据源，会自动展示该数据源下的所有表名称，方便辅助用户编写业务逻辑sql。 由于不同数据库查询所有表名称的方式都不一样，所以需要用户手动去填写这个sql

标题插件

DBApi的插件分3类，分别是数据转换插件、缓存插件、告警插件
插件需要用户自己编写java代码开发。开发完成后打成jar包，并放入DBApi的lib目录下即可以使用
详细请阅读插件指南

标题数据转换插件

有时候sql无法一次性获得自己想要的数据格式，如果用代码对数据进行一些处理转换能更加方便，这时候就要用到数据转换插件。用户自己编写数据转换逻辑的代码。
典型场景，比如针对sql查询结果中的用户手机号、银行卡号进行加密脱敏。
#缓存插件
主要是对查询类API，sql查询结果进行缓存，这样避免频繁的查询数据库，对数据库造成压力。
缓存逻辑由用户自己编写，用户可以缓存到redis/mongodb/elasticsearch等等。
如果开启了缓存，当从缓存中查询不到数据时，才去数据库查询，同时将结果缓存下来。

标题告警插件

当API内部报错的时候，告警插件可以将报错信息发送告警提醒，比如发邮件、发短信
告警逻辑由用户自己编写

标题springboot集成

如果您想更加灵活的使用DBApi，在您自己的java springboot项目中使用代码配置接口， 请使用dbApi-spring-boot-starter开源框架(opens new window)
#注意事项

标题数据源支持

如果您要使用Oracle或者其他类型的数据源，请将相应的jdbc驱动包手动放入DBApi部署后的lib目录下（如果是集群部署每个节点都需要手动放入jar包）

标题sql编写规范

和mybatis动态sql语法一样，同样支持参数#{}、 ${}，可以参考mybatis文档 (opens new window)，不需要写最外层的 标签，直接写sql内容
注意和mybatis一样，sql里的小于号不要写成<，要写成 <
#权限校验流程