01.简介
# 使用指南
# 介绍
狭义上说，动态DB接口是一个面向数仓开发人员的低代码工具，只需在页面上编写sql，并配置好参数，就可以自动生成http接口。它可以帮助程序员快速的开发后端数据接口，尤其适用于BI报表、数据可视化大屏的后端接口开发。
广义上说，动态DB接口是整个企业数据接口的管理中心，是企业对外提供数据服务的管理平台。它提供了数据接口的动态创建发布功能，对接口的统一管理，并提供了对客户端的管理能力，可以监控客户端对接口的调用、控制客户端对接口的权限。
在线动态DB接口基于Java的接口进行封装的组件，编写接口将通过简搭云可视化表单系统提供的UI界面完成，自动映射为HTTP接口，无需定义Controller、Service、Dao、Mapper、XML、VO等Java对象即可完成常见的HTTP API接口开发
体验地址：
最新发行版：
# 特点
- 开箱即用，不需要编程，单机模式不需要依赖其他软件（只需要java运行环境）
- 支持单机模式、集群模式，支持windows Linux mac
- 支持动态创建、修改API；动态创建、修改数据源。热部署全程无感。
- 支持动态sql，类似mybatis的动态sql，支持sql编辑、运行、调试
- 支持API配置导入导出，方便测试环境到生产环境的API迁移
- 支持一个接口内多条SQL执行（例如分页功能），支持事务开启关闭
- 支持复杂嵌套JSON传参
- 支持声明临时变量
- 支持多数据源配置，支持在线配置数据源
- 支持SQL缓存，以及自定义SQL缓存
- 支持自定义JSON结果、自定义分页结果
- 支持若依的数据权限兼容
- 支持接口文档生成
- 支持动态配置定时任务
- 支持后端java代码调用
- 支持脚本代码自动提示、参数提示、悬浮提示、错误提示
- 支持脚本代码表、字段的提示。
- 封装的代码简单，只有2000行核心代码。
- 支持表单自动创建接口
# 快速开始
我们将通过一个简单的demo来阐述kyFormApi的功能。假设您已经：
本地部署了可视化表单系统或者可视化大屏系统。 拥有Mysql环境，熟悉mybatis基本语法
先在创建formdata库中创建一张测试表TestData,结构如下
| id | name |
|---|---|
| 1 | 简搭云可视化表单 |
| 2 | 简搭云可视化大屏 |
创建表SQL如下：
create table test_data
(
id bigint not null
primary key,
name varchar(100) null
);
INSERT INTO test_data (id, name) VALUES (1, '简搭云可视化表单');
INSERT INTO test_data (id, name) VALUES (2, '简搭云可视化大屏');
2
3
4
5
6
7
8
进入可视化表单，系统工具=》动态接口，界面如下
右侧是接口目录，左侧是接口文档与调试信息。
*鼠标移入到接口目录数据上，会显示新增(接口)，修改（修改目录），删除（删除目录）。
新增动态kyFormApi接口界面如下：
切换【测试】界面，调试结果如下：
点击保存，即一个动态接口完成。我们回到接口文档中测试一把。
由网络请求可以看出，我们请求的是：http://localhost:8083/api/flow/oa/comm/testCommApi/form_8a8m.testdata (opens new window)
而form_8a8m就是目录的编码，testdata是动态接口编码。
# 小结
通过以上几个步骤，我们就实现了一个简单的查询功能。省去了Controller、Service、Dao、Mapper、XML、VO等模板代码的工作量。