techciceksepeti/sqlapi

SQL API 镜像文档

镜像概述和主要用途

SQL API 旨在无需任何配置即可通过简单的 HTTP 调用来运行数据库查询。请求中包含数据库凭据和查询语句。警告！请勿在生产环境中使用，该工具适用于测试环境，特别是集成测试场景。

核心功能和特性

• 无需预先配置，通过 HTTP 请求直接执行数据库查询
• 请求中包含完整的数据库连接信息和查询语句
• 支持多种主流数据库类型
• 简洁的 JSON 响应格式，直接返回查询结果

支持的数据库

• MySQL
• MSSQL
• MongoDB

使用场景和适用范围

• 测试环境中的数据库查询验证
• 集成测试中快速执行数据库操作
• 临时查询数据库数据，无需复杂的客户端配置
• 自动化测试中的数据库交互环节

使用方法和配置说明

启动容器

通过以下命令启动名为 sqlapi 的 Docker 容器：

bash
docker run --rm --name sqlapi -p 8033:8033 techciceksepeti/sqlapi

示例请求

MySQL 查询示例

bash
curl -X POST http://localhost:8033/sql \
  -d '{
        "db": {
            "type": "mysql",
            "host": "hostname:3306",
            "name": "DBName",
            "user": "username",
            "password": "pass"
        },
        "query": "SELECT * from TableName LIMIT 1"
    }'

响应示例

响应将直接返回数据库查询结果行：

json
[
  {
    "Id": 1,
    "Name": "Electronic",
    "Type": 2,
    "Sequence": 1
  }
]

MongoDB 查询示例

bash
curl -X POST http://localhost:8033/sql \
  -d '{
        "db": {
            "type": "mongodb",
            "host": "localhost:27017",
            "name": "DBName",
            "user": "mongoadmin",
            "password": "secret"
        },
        "collection": "CollectionName",
        "query": "{\"_id\":\"609a80caa23379b236426ad2\"}"
    }'

许可证

SQL API 是开源软件，基于 MIT 许可证授权。