快速开始
在线体验
- https://admin.sqlapis.com
- 体验用户: demo / Demo@2026
- 数据规则:
- demo 密码每分钟自动重置
- 体验数据每天 05:12 重置
本地体验
本文让您快速在本地启动体验本系统
环境准备
- 梯子: 用到了Docker镜像, Github 资源
- Docker 环境 （请自行安装 Docker Desktop）
拉取代码
shell
git clone https://github.com/shrimp-cloud/shrimp-sql2api.git模块清单
| 模块名 | 功能 | 说明 |
|---|---|---|
| sql2api-engine | 引擎核心 | 此模块作为 Jar 包，被主应用依赖。依赖后，可使用已经定义好的 API 接口。但不包含接口管理等功能 |
| sql2api-manager | 接口管理 | 此模块作为 Jar 包，被主应用依赖。依赖后，可使用接口管理的全部功能。此模块无法单独启动 |
| sql2api-starter | 管理端启动器 | 此模块包含启动类，可独立打包和启动。可启动为独立的管理端，再将维护好的 API 供给其他系统使用 |
| sql2api-ui | 管理端页面 | 管理端 UI 界面。提供独立打包，也提供合并到 starter 打包的能力 |
| sql2api-doc | 文档 | 当前文档的源码 |
| sql2api-nginx | 入口代理 | 用于本地快速启动测试的入口聚合。实际情况请根据自己需要确认此模块的去留 |
本地 Docker 启动
shell
docker compose up --build| 模块 | 地址 |
|---|---|
| 管理界面 | http://admin.dev.sqlapis.com |
| 使用文档 | http://doc.dev.sqlapis.com |
- 体验用户: demo / Demo@2026
- *.dev.sqlapis.com 域名已经解析到了 127.0.0.1, 方便本地体验