jeffknupp/sandman2

sandman2

镜像概述和主要用途

sandman2 是一个能从现有数据库自动生成RESTful API服务的工具，无需编写任何代码。只需将其指向数据库，就能立即启动一个支持超媒体的完整RESTful API服务，使各类数据库（从SQLite到PostgreSQL）都能通过HTTP请求进行程序化访问，实现数据解放。

核心功能和特性

• 零代码API生成：无需编写代码，自动根据数据库模式生成RESTful API
• 广泛数据库支持：兼容SQLAlchemy支持的所有数据库（MySQL、PostgreSQL、Oracle等）及第三方扩展数据库
• 现代化管理界面：提供改进的管理界面，优化了大量表的显示布局，保留原功能
• 灵活部署：可通过命令行工具（sandman2ctl）或Docker容器运行
• 超媒体支持：生成的API包含超媒体链接，符合REST最佳实践

使用场景和适用范围

• 需要为遗留数据库快速提供API接口的场景
• 开发者需要访问其他团队数据库但缺乏合适接口时
• 原型开发阶段需要快速搭建数据访问层
• 希望避免编写重复的数据库连接和ORM代码的项目
• 需要通过标准化HTTP接口访问多种数据库的系统

详细使用方法和配置说明

快速开始

通过pip安装sandman2：

bash
$ pip install sandman2

安装后可使用sandman2ctl命令行工具，只需提供数据库URI即可启动服务：

SQLite数据库示例：

bash
$ sandman2ctl sqlite+pysqlite:///database_file_name

PostgreSQL数据库示例（需先安装驱动如psycopg2）：

bash
$ pip install psycopg2
$ sandman2ctl postgresql+psycopg2://scott:tiger@localhost/mydatabase

数据库连接字符串格式详见SQLAlchemy文档

支持的数据库

• 原生支持：MySQL、PostgreSQL、Oracle、Microsoft SQL Server、SQLite、Sybase、Drizzle、Firebird
• 第三方扩展支持：IBM DB2、Amazon Redshift、SQL Anywhere、MonetDB

管理界面

sandman2包含现代化的管理界面，优化了大量表的显示布局。启动服务后，可通过http://<host>:<port>/admin/访问管理界面。

自定义配置

若需更精细的控制或限制表访问范围，可将sandman2集成到应用中，详见官方文档。

Docker部署

镜像获取

bash
$ docker pull jeffknupp/sandman2

运行示例（连接本地PostgreSQL数据库，适用于macOS）

bash
$ docker run -d \
  -e DB_TYPE=postgres \
  -e DB_DRIVER=psycopg2 \
  -e USERNAME=jknupp \
  -e PASSWORD=tiger \
  -e DB_HOST=host.docker.internal \
  -e DATABASE=jknupp \
  -e DB_PORT=5432 \
  -p 9000:5000 \
  jeffknupp/sandman2

访问服务：

• API元数据：curl localhost:9000/meta
• 管理界面：http://localhost:9000/admin/

注：DB_HOST=host.docker.internal仅适用于连接主机系统数据库（macOS），连接远程数据库时替换为对应IP或主机名。

环境变量参数说明

通过-e <参数名>=<值>方式传递环境变量，具体所需参数因数据库类型而异。