如何使用QuickAPI从零基于SQL生成数据API？

目录

一、QuickAPI简介

二、环境准备

三、实现步骤

步骤1：配置数据库连接

步骤2：创建API

步骤4：验证API

四、注意事项

五、总结

在开发中，快速将数据库数据暴露为API是常见需求，特别是针对数据仓库或数据湖的场景。

传统方式需要编写后端代码、搭建服务器，耗时较长。而麦聪QuickAPI提供了一种低代码方案，只需SQL即可生成数据API。

本文将详细介绍如何使用QuickAPI基于SQL从零构建数据API，适用于熟悉数据库但不擅长后端开发的工程师。

一、QuickAPI简介

QuickAPI是麦聪软件推出的一款低代码工具：统一数据服务平台，旨在将数据库查询快速通过SQL转换为RESTful API。

它支持MySQL、PostgreSQL等多种全球主流数据库和华为、阿里、达梦、人大金仓等多种国产数据库，用户通过编写SQL语句即可生成API，无需编写服务端代码或手动部署服务器。

本文以MySQL为例，展示完整实现流程。

二、环境准备

开始前需准备以下内容：

1. QuickAPI工具：从麦聪官网下载最新版本，安装过程免安装，参考官网文档。
2. MySQL数据库：确保已有一个可用的数据库。本例使用以下“products”表：

   CREATE TABLE products (
     id INT PRIMARY KEY AUTO_INCREMENT,
     name VARCHAR(50),
     price DECIMAL(10, 2),
     stock INT
   );
    
    
   INSERT INTO
     products (name, price, stock)
   VALUES
     ('蓝牙耳机', 199.00, 50),
     ('机械键盘', 399.00, 30),
     ('USB充电线', 29.00, 100);

3. SQL基础：熟悉基本的SELECT语句即可。

三、实现步骤

步骤1：配置数据库连接

1. 安装并启动QuickAPI，进入主界面。
2. 在“数据源管理”中点击“添加数据源”，选择“MySQL”。
3. 输入连接参数：
   • 主机名：localhost（本地数据库）
   • 端口：3306
   • 用户名/密码：MySQL账户凭据
4. 点击“测试连接”，确认成功后保存。

此步骤建立QuickAPI与数据库的连接，后续操作依赖此配置。

步骤2：创建API

1. 在QuickAPI界面，进入“API管理”，点击“新建API”。
2. 配置API参数：
   • 名称：产品相关的路径
   • 请求方法：GET
   • 路径：product/basic
3. 在“SQL脚本”区域输入上述SQL。

   select
     pd.id,
     pd.name,
     pd.price,
     pd.stock
   from
     products pd
   where
     pd.id > {{productNo}}

   

4. 保存并点击“测试”，QuickAPI会生成API并提供本地访问地址，例如：

   

步骤4：验证API

使用浏览器或Postman访问生成的地址，参考调用文档：如何安全调用数据API - QuickAPI产品文档

四、注意事项

1. 安全性：生产环境需配置API访问权限，避免数据泄露。
2. 性能：复杂SQL可能影响响应速度，建议优化查询语句。
3. 版本兼容：确保QuickAPI版本与数据库驱动匹配。

五、总结

QuickAPI通过SQL直接生成数据API，省去了传统后端开发的繁琐步骤。

本文展示了从数据库配置到API生成的全流程，核心在于SQL编写与API配置。对于快速原型开发或小型项目，QuickAPI是高效选择。读者可根据实际需求进一步探索其高级功能。