swaggerql/swaggerql-postgres

swaggerql

SwaggerQL的PostgreSQL数据库RESTful Web服务器镜像，无需编码即可通过Swagger文件快速构建带透明文档的参考微服务，支持SQL查询嵌入与多种数据库连接。

1 次收藏下载次数: 0状态：社区镜像维护者：swaggerql仓库类型：镜像最近更新：6 年前

让 AI 帮你使用轩辕镜像？ · 展开查看说明

如果你使用 DeepSeek、元宝 AI、Copilot、ChatGPT 等 AI 工具，协助配置轩辕镜像、编写 docker pull 命令、修改 Docker Compose 镜像地址、配置镜像加速、排查镜像拉取失败、分析报错日志等问题，请先让 AI 阅读并遵守轩辕镜像的规则文档。

只需在 AI 对话中先发送下面这句话即可：

请先完整阅读并严格遵守以下文档中的全部规则与要求：

https://xuanyuan.cloud/agents.md

在未充分阅读并理解该文档前，不要生成任何命令、配置、修改建议、故障排查方案或技术回答。后续所有输出都必须严格以该文档中的规范为最高优先级执行。

查看 agents.md 用法指南与完整示范。国内用户首推元宝 AI、DeepSeek 的深度思考模式，不推荐豆包 AI；Cursor 等编辑器可在对话 @ 该链接，或加入 User Rules。若 AI 无法访问外链，可打开说明文档复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。

镜像标签列表与下载命令

SwaggerQL

https://travis-ci.org/swaggerql/swaggerql.svg?branch=master](https://travis-ci.org/swaggerql/swaggerql) https://img.shields.io/badge/docker-swaggerql--mysql-green](https://hub.docker.com/r/swaggerql/swaggerql-mysql) https://img.shields.io/badge/docker-swaggerql--mariadb-green](https://hub.docker.com/r/swaggerql/swaggerql-mariadb) https://img.shields.io/badge/docker-swaggerql--postgres-green](https://hub.docker.com/r/swaggerql/swaggerql-postgres) https://img.shields.io/badge/docker-swaggerql--oracle-green](https://hub.docker.com/r/swaggerql/swaggerql-oracle) https://img.shields.io/badge/docker-swaggerql--sqlite-green](https://hub.docker.com/r/swaggerql/swaggerql-sqlite)

Swagger + SQL = 无需编码即可构建带透明文档的参考微服务。只需创建Swagger文件并在描述中指定SQL查询即可使用。

镜像概述

SwaggerQL是一款将Swagger文档与SQL查询结合的工具，旨在快速构建轻量级RESTful Web服务。该镜像针对PostgreSQL数据库优化，支持通过配置文件连接数据库，并通过Swagger文档定义API接口与嵌入SQL逻辑，适用于快速原型开发、内部微服务搭建等场景。

核心功能

无代码API构建：通过Swagger文件定义接口，在描述中嵌入SQL查询即可生成API
多数据库支持：兼容PostgreSQL、MySQL、MariaDB、SQLite等多种数据库（需对应镜像）
参数绑定：支持从路径、查询、表单参数传递值到SQL查询
事务支持：通过X-Transaction header实现事务包裹查询
灵活配置：通过配置文件、CLI参数或环境变量自定义服务端口、数据库连接等

使用场景

需要为现有数据库快速搭建内部简单查询微服务
快速生成参考服务原型验证业务逻辑
测试数据库中的数据内容
构建用于测试部署脚本的数据库访问存根应用

配置说明

连接数据库

使用https://github.com/tgriesser/knex库连接数据库，配置文件格式示例（PostgreSQL）：

yaml
client: pg
connection:
  host: 127.0.0.1
  user: your_database_user
  password: your_database_password
  database: myapp_test

更多连接配置参考knex文档。

REST API定义

通过OpenAPI文档定义接口，在description字段嵌入SQL查询：

yaml
paths:
  /increment:
    get:
      summary: 数字N加1
      description: |
        SELECT 1 + :n
      parameters:
      - name: n
        in: query
        required: true
        schema:
          type: integer
      responses:
        200:
          description: OK

支持Markdown格式包裹SQL代码块，以及参数绑定（:name为值绑定，:name:为标识符绑定）。

CLI参数

可通过命令行参数覆盖配置：

sh
$(npm bin)/swaggerql --help
# 选项包括：--input-spec（Swagger文件路径）、--port（服务端口）、--client（数据库驱动）等

环境变量支持：SWAGGERQL_INPUT_SPEC、SWAGGERQL_PORT、SWAGGERQL_CLIENT等。

Docker部署示例

PostgreSQL镜像运行

sh
docker run -it --rm -p 8000:8000 \
        -v $(pwd)/config/local.yaml:/app/config/production.yaml \
        -v $(pwd)/openapi.yaml:/app/openapi.yaml \
        docker.xuanyuan.run/swaggerql/swaggerql-postgres

访问http://0.0.0.0:8000即可查看API文档与测试接口。

其他数据库镜像

可替换镜像名称使用对应数据库版本：swaggerql-mysql、swaggerql-mariadb、swaggerql-oracle、swaggerql-sqlite。

镜像拉取方式

您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问标签列表页面。

轩辕镜像加速拉取命令点我查看更多 swaggerql-postgres 镜像标签

docker pull docker.xuanyuan.run/swaggerql/swaggerql-postgres:<标签>

使用方法：

DockerHub 原生拉取命令

docker pull swaggerql/swaggerql-postgres:<标签>

轩辕镜像配置手册

按平台快速找到配置文档

一键安装

一键安装 Docker

Linux Docker 一键安装

AI

用 AI 使用轩辕镜像

agents.md · AI 对话 · 提示词

Docker

登录仓库拉取

登录认证 · 私有仓库

专属域名拉取

免登录 · 高速拉取

Linux

Docker 镜像配置

Windows / Mac

Docker Desktop 配置

MacOS OrbStack

OrbStack 容器

Apple Container

macOS 原生容器

Docker Compose

Compose 项目配置

NAS

群晖

Synology 配置

飞牛

fnOS 镜像配置

绿联

绿联 NAS

威联通

QNAP 配置

极空间

极空间 NAS

Unraid

Unraid NAS

企业仓库

其他仓库

ghcr · Quay · nvcr

Harbor 镜像源

Proxy Repository 对接

Portainer 镜像源

Registries 配置

Nexus 镜像源

Docker Proxy 缓存

开发工具

Dev Containers

VS Code 开发容器

Podman

Podman 配置指南

Singularity / Apptainer

HPC 科学计算容器

Kubernetes

K8s Containerd

Kubernetes · Containerd

K3s

轻量级集群

面板 / 网络

爱快路由

爱快 4.0 · iKuai 镜像加速

宝塔面板

一键配置镜像源

需要其他帮助？请查看我们的常见问题Docker 镜像访问常见问题解答或提交工单

镜像拉取常见问题

功能

版本功能对比

功能对比 · 版本选择

支持的镜像仓库

Docker Hub · GCR · GHCR

专属域名用法

专属域名 · 开启停用 · 多仓库

新手拉取配置

docker search 限制

专属域名 · Hub 搜索

不支持 push

仅支持 pull · 不支持

拉取速度原因

带宽 · 缓存 · 冷热镜像

错误码

402 与流量用尽

402 · 流量包 · 充值

401 认证失败

401 · docker login

manifest unknown

标签错误 · 镜像不存在

410 Gone 排查

410 · Docker 升级

429 限流

免费版 · 专业版 · 企业版 · 请求频率

其他报错

DNS 超时

DNS 解析 · 网络超时

TLS 证书失败

no matching manifest（架构）

账号

失败是否计费

manifest · blob · 计费

申请开票（企业 / 个人）

开票 · 发票 · 工单

修改登录密码

网站 · 仓库 · 重置

注销账户

工单 · 数据 · 注销

原理

mirrors 不生效

daemon.json · 重启

去掉域名前缀

docker tag · 重命名

指定架构拉取

ARM64 · AMD64 · 多架构

latest 与「最新」

digest · 版本号 · 标签

查看全部问题→

用户好评

来自真实用户的反馈，见证轩辕镜像的优质服务

oldzhang

运维工程师

Linux服务器

"Docker访问体验非常流畅，大镜像也能快速完成下载。"