PostgREST:自动 API
使用 Pigsty Compose 模板部署 PostgREST,基于 PostgreSQL 模式自动生成 REST API。
PostgREST 可以将 PostgreSQL schema 直接暴露为 REST API。
Pigsty 提供 app/postgrest 模板,以只读用户 dbuser_view 提供 Pigsty CMDB API 示例。Compose 默认将 POSTGREST_SERVER_PORT(默认 8884)仅绑定到宿主机回环地址 127.0.0.1。
快速开始
默认访问入口:
http://127.0.0.1:8884- 远程访问使用 SSH 隧道,或配置带认证的 Nginx 门户
http://api.pigsty
关键配置
.env 常用参数:
POSTGREST_SERVER_PORT:服务监听与回环映射端口(默认8884)POSTGREST_DB_URI:数据库连接串POSTGREST_DB_SCHEMA:暴露的 schema(默认pigsty)POSTGREST_DB_ANON_ROLE:匿名角色POSTGREST_JWT_SECRET:JWT 密钥
将 POSTGREST_JWT_SECRET 改为至少 32 字符的随机值。配置 JWT 密钥本身不会禁止匿名访问;POSTGREST_DB_ANON_ROLE 仍决定未认证请求的数据库权限。make run 已作为 make up 的别名,统一使用上述 Compose 回环绑定配置。
Swagger UI(可选)
可单独拉起 Swagger UI 预览 API:
访问 http://127.0.0.1:8883。服务位于远程主机时,先转发两个端口:
常用命令
参考
- PostgREST 文档: https://postgrest.org/en/stable/
- Pigsty 模板: https://github.com/pgsty/pigsty/tree/main/app/postgrest
这个页面对您有帮助吗?
感谢反馈,我们会据此改进这篇文档。
哪里没有解决?(可选)