# sql-api

**Repository Path**: li-jia-fu/sql-api

## Basic Information

- **Project Name**: sql-api
- **Description**: sql-api
- **Primary Language**: Unknown
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2026-06-05
- **Last Updated**: 2026-07-01

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# API Builder

一个快速开发API的工具，支持通过SQL语句快速创建RESTful API接口。

## 功能特点

- **SQL转API**：通过编写SQL语句快速创建RESTful API
- **多数据源支持**：支持SQLite、MySQL、PostgreSQL等多种数据库
- **用户认证**：JWT token认证
- **API管理**：支持API的创建、编辑、发布和测试
- **参数化查询**：支持动态参数替换
- **Web界面**：简洁的管理界面

## 快速开始

### 安装依赖

```bash
npm install
```

### 启动服务

```bash
npm start
```

开发模式（自动重启）：

```bash
npm run dev
```

### 访问应用

打开浏览器访问：http://localhost:3000

默认登录账号：
- 用户名：admin
- 密码：admin123

## 项目结构

```
api-builder/
├── public/              # 前端静态文件
│   ├── index.html       # 主页面
│   └── app.js           # 前端JavaScript
├── src/
│   ├── config/          # 配置文件
│   │   └── index.js
│   ├── controllers/     # 控制器
│   │   ├── authController.js
│   │   ├── dataSourceController.js
│   │   └── apiController.js
│   ├── database/        # 数据库
│   │   └── db.js
│   ├── middleware/      # 中间件
│   │   └── auth.js
│   ├── services/        # 业务逻辑
│   │   ├── authService.js
│   │   ├── dataSourceService.js
│   │   └── apiService.js
│   ├── utils/           # 工具函数
│   │   └── logger.js
│   ├── routes/          # 路由
│   │   └── index.js
│   └── app.js           # 应用入口
├── data/                # 数据库文件目录
├── package.json
└── README.md
```

## 使用说明

### 1. 配置数据源

- 登录后进入"Data Sources"页面
- 点击"Add Data Source"添加数据源
- 支持SQLite、MySQL、PostgreSQL
- 可以先测试连接是否成功

### 2. 创建API

- 进入"APIs"页面
- 点击"Create API"创建新接口
- 填写接口信息：名称、路径、方法等
- 选择数据源并编写SQL语句
- 配置请求参数
- 保存后可以测试接口

### 3. 使用参数

在SQL中使用 `${paramName}` 来引用参数：

```sql
SELECT * FROM users WHERE id = ${userId}
```

然后在参数配置中添加 `userId` 参数。

## API文档

Swagger文档地址：http://localhost:3000/api-docs

## 技术栈

- **后端**：Node.js + Express
- **数据库**：SQLite（默认），支持MySQL/PostgreSQL
- **认证**：JWT
- **前端**：Bootstrap 5 + Vanilla JavaScript

## 许可证

MIT