# apiSQL: API开发 = 一句SQL

## 引言

apiSQL 是一个创新的API开发平台，旨在通过“一句SQL”的理念，极大地简化API的创建、管理和发布。它将复杂的数据库操作抽象为简单的API接口，使得开发者和业务用户能够高效地将数据转化为可消费的服务。

## 核心功能概述

apiSQL 的核心价值在于其“低代码/零代码”的API开发模式，主要功能包括：
- **API开发**：将数据库的表、视图、自定义函数、存储过程封装为API。
- **多数据源支持**：支持多种数据库类型和数据源集成。
- **接口设计与调试**：提供直观的界面进行API接口的定义、参数配置和在线调试。
- **动态特性**：支持API属性、批量API、RESTful接口和SUDB等高级功能。
- **前后置操作**：允许通过脚本（JS）在API执行前后进行数据处理、逻辑控制等。
- **权限与访问控制**：细粒度的项目、成员、角色和权限管理。
- **数据管理**：提供数据管理功能。

## 文档知识体系

以下是apiSQL文档的主要结构和关键主题，自动化系统可以通过这些信息快速定位所需知识：

### 1. 入门
- **apiSQL简介**：介绍apiSQL的核心功能和应用场景。
  - [链接: apiSQL简介](https://docs.apisql.cn/apisql/010@%E5%85%A5%E9%97%A8/010@APISQL%E7%AE%80%E4%BB%8B/readme.html)
- **快速入门**：提供平台操作流程、注册、项目创建、网关安装、数据源增加、API接口组创建、SQL调试、SQL参数、策略新建与绑定、接口调试工具等步骤。
  - [链接: 快速入门](https://docs.apisql.cn/apisql/010@%E5%85%A5%E9%97%A8/020@%E5%BF%AB%E9%80%9F%E5%85%A5%E9%97%A8/readme.html)
- **免费版-私有部署**：介绍免费版功能及私有部署方式。
  - [链接: 免费版-私有部署](https://docs.apisql.cn/apisql/010@%E5%85%8D%E8%B4%B9%E7%89%88-%E7%A7%81%E6%9C%89%E9%83%A8%E7%BD%B2/readme.html)
- **企业版-私有部署**：介绍企业版部署的准备工作、在线安装、离线安装及技术支持。
  - [链接: 企业版-私有部署](https://docs.apisql.cn/apisql/010@%E5%85%A5%E9%97%A8/040@%E4%BC%81%E4%B8%9A%E7%89%88-%E7%A7%81%E6%9C%89%E9%83%A8%E7%BD%B2/readme.html)

### 2. 接口开发指南
- **接口组**：如何新建和管理API接口组。
  - [链接: 接口组](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/010@%E6%8E%A5%E5%8F%A3%E7%BB%84/readme.html)
- **接口**：
  - **接口介绍**：基本概念和新建接口流程。
    - [链接: 接口介绍](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/020@%E6%8E%A5%E5%8F%A3/010@%E6%8E%A5%E5%8F%A3%E4%BB%8B%E7%BB%8D/readme.html)
  - **接口设计**：
    - **SQL类型**：基于SQL语句的接口设计。
      - [链接: SQL类型](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/020@%E6%8E%A5%E5%8F%A3/020@%E6%8E%A5%E5%8F%A3%E8%AE%BE%E8%AE%A1/010@SQL%E7%B1%BB%E5%9E%8B/readme.html)
    - **MoreSQL类型**：高级SQL接口设计。
      - [链接: MoreSQL类型](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/020@%E6%8E%A5%E5%8F%A3/020@%E6%8E%A5%E5%8F%A3%E8%AE%BE%E8%AE%A1/020@MoreSQL%E7%B1%BB%E5%9E%8B/moreSql.html)
    - **JS类型**：通过JavaScript脚本实现接口逻辑。
      - [链接: JS类型](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/020@%E6%8E%A5%E5%8F%A3/020@%E6%8E%A5%E5%8F%A3%E8%AE%BE%E8%AE%A1/030@JS%E7%B1%BB%E5%9E%8B/js.html)
  - **接口运行(调试)**：接口功能简介、步骤和请求参数。
    - [链接: 接口运行(调试)](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/020@%E6%8E%A5%E5%8F%A3/030@%E6%8E%A5%E5%8F%A3%E8%BF%90%E8%A1%8C(%E8%B0%83%E8%AF%95)/010@%E5%8A%9F%E8%83%BD%E7%AE%80%E4%BB%8B/readme.html)
- **动态特性**：
  - **API属性**：API的元数据和配置。
    - [链接: API属性](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/030@%E5%8A%A8%E6%80%81%E7%89%B9%E6%80%A7/0010@API%E5%B1%9E%E6%80%A7.html)
  - **批量API**：如何处理批量API请求。
    - [链接: 批量API](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/030@%E5%8A%A8%E6%80%81%E7%89%B9%E6%80%A7/0020@%E6%89%B9%E9%87%8FAPI.html)
  - **REST**：RESTful接口的实现与局限性。
    - [链接: REST](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/030@%E5%8A%A8%E6%80%81%E7%89%B9%E6%80%A7/0030@REST.html)
  - **SUDB**：SUDB功能介绍与使用。
    - [链接: SUDB](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/030@%E5%8A%A8%E6%80%81%E7%89%B9%E6%80%A7/0040@SUDB.html)
- **前后置操作**：
  - **功能简介**：前置操作和后置操作的概述。
    - [链接: 功能简介](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/040@%E5%89%8D%E5%90%8E%E7%BD%AE%E6%93%8D%E4%BD%9C/010@%E5%8A%9F%E8%83%BD%E7%AE%80%E4%BB%8B/%E5%8A%9F%E8%83%BD%E7%AE%80%E4%BB%8B.html)
  - **脚本**：
    - **脚本介绍**：前置脚本和后置脚本的介绍。
      - [链接: 脚本介绍](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/040@%E5%89%8D%E5%90%8E%E7%BD%AE%E6%93%8D%E4%BD%9C/020@%E8%84%9A%E6%9C%AC/0010@%E8%84%9A%E6%9C%AC%E4%BB%8B%E7%BB%8D.html)
    - **前置脚本**：前置脚本的示例和使用。
      - [链接: 前置脚本](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/040@%E5%89%8D%E5%90%8E%E7%BD%AE%E6%93%8D%E4%BD%9C/020@%E8%84%9A%E6%9C%AC/0020@%E5%89%8D%E7%BD%AE%E8%84%9A%E6%9C%AC.html)
    - **后置脚本**：后置脚本的示例和使用。
      - [链接: 后置脚本](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/040@%E5%89%8D%E5%90%8E%E7%BD%AE%E6%93%8D%E4%BD%9C/020@%E8%84%9A%E6%9C%AC/0030@%E5%90%8E%E7%BD%AE%E8%84%9A%E6%9C%AC.html)
    - **公共脚本**：公共脚本的使用。
      - [链接: 公共脚本](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/040@%E5%89%8D%E5%90%8E%E7%BD%AE%E6%93%8D%E4%BD%9C/020@%E8%84%9A%E6%9C%AC/0040@%E5%85%AC%E5%85%B1%E8%84%9A%E6%9C%AC.html)
    - **ctx对象**：ctx对象的TS类型定义。
      - [链接: ctx对象](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/040@%E5%89%8D%E5%90%8E%E7%BD%AE%E6%93%8D%E4%BD%9C/020@%E8%84%9A%E6%9C%AC/0050@ctx%E5%AF%B9%E8%B1%A1.html)
- **语法指南**：
  - **SQL语句**：命名参数的使用。
    - [链接: SQL语句](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/050@%E8%AF%AD%E6%B3%95%E6%8C%87%E5%8D%97/0010@SQL%E8%AF%AD%E5%8F%A5.html)
  - **JSAPI脚本指南**：全局方法和示例。
    - [链接: JSAPI脚本指南](https://docs.apisql.cn/apisql/020@%E6%8E%A5%E5%8F%A3%E5%BC%80%E5%8F%91%E6%8C%87%E5%8D%97/050@%E8%AF%AD%E6%B3%95%E6%8C%87%E5%8D%97/0020@JSAPI%E8%84%9A%E6%9C%AC%E6%8C%87%E5%8D%97.html)

### 3. 项目
- **访问控制**：认证类型。
  - [链接: 访问控制](https://docs.apisql.cn/apisql/030@%E9%A1%B9%E7%9B%AE/0010@%E8%AE%BF%E9%97%AE%E6%8E%A7%E5%88%B6.html)
- **数据网关&数据源**：数据网关和数据源的介绍。
  - [链接: 数据网关&数据源](https://docs.apisql.cn/apisql/030@%E9%A1%B9%E7%9B%AE/0020@%E6%95%B0%E6%8D%AE%E7%BD%91%E5%85%B3%EF%BC%86%E6%95%B0%E6%8D%AE%E6%BA%90.html)
- **成员角色&权限**：项目角色管理。
  - [链接: 成员角色&权限](https://docs.apisql.cn/apisql/030@%E9%A1%B9%E7%9B%AE/0030@%E6%88%90%E5%91%98%E8%A7%92%E8%89%B2%EF%BC%86%E6%9D%83%E9%99%90.html)
- **数据管理**：数据管理的使用。
  - [链接: 数据管理](https://docs.apisql.cn/apisql/030@%E9%A1%B9%E7%9B%AE/0040@%E6%95%B0%E6%8D%AE%E7%AE%A1%E7%90%86.html)

### 4. 案例
- **apiSQL与HertzBeat(实时监控告警)的零代码实现**：通过apiSQL设计API获取库存数据，并在HertzBeat中新增HTTP协议监控模板和监控。
  - [链接: apiSQL与HertzBeat](https://docs.apisql.cn/apisql/040@%E6%A1%88%E4%BE%8B/010@APISQL%E4%B8%8EHertzBeat(%E5%AE%9E%E6%97%B6%E7%9B%91%E6%8E%A7%E5%91%8A%E8%AD%A6)%E7%9A%84%E9%9B%B6%E4%BB%A3%E7%A0%81%E5%AE%9E%E7%8E%B0.html)

## 智能系统与apiSQL的结合点

apiSQL作为数据接口层，可以极大地赋能智能系统在数据访问和应用集成方面的能力：

1.  **数据查询与分析**：智能系统可以通过apiSQL生成的API，直接以自然语言或结构化查询的方式访问后端数据库，进行数据查询、报表生成和数据分析，无需深入了解数据库底层细节。
2.  **自动化工作流**：结合apiSQL的前后置脚本能力，智能系统可以触发复杂的业务逻辑，实现自动化数据处理、通知发送或与其他系统的集成。
3.  **智能API生成**：智能系统可以根据业务需求，辅助生成apiSQL的SQL或JS类型接口，加速API开发过程。
4.  **文档与知识问答**：智能系统可以利用本文件及链接指向的详细文档，作为apiSQL的知识库，提供准确、实时的产品功能、使用方法和最佳实践问答。
5.  **数据驱动的应用开发**：智能系统可以作为智能代理，通过apiSQL提供的API，快速构建数据驱动的应用程序，实现更智能的用户交互和业务流程。

## 联系方式与资源

- **官网**：[https://www.apiSQL.cn/](https://www.apiSQL.cn/)
- **在线版**：[https://open.apiSQL.cn/](https://open.apiSQL.cn/)
- **资料网盘资料**： [https://drive.weixin.qq.com/s?k=AI8APQeSAAcVA9D0E8](https://drive.weixin.qq.com/s?k=AI8APQeSAAcVA9D0E8)
- **博客**：[https://www.apiSQL.cn/blog/](https://www.apiSQL.cn/blog/)
- **GitHub**：[https://github.com/yyimen/apisqldoc.git](https://github.com/yyimen/apisqldoc.git)
- **B站**：[https://space.bilibili.com/282182253](https://space.bilibili.com/282182253)
- **CSDN**：[https://apiSQL.blog.csdn.net/](https://apiSQL.blog.csdn.net/)