brandonvfx/sg-restful
brandonvfx
自动构建
SG Restful是Shotgun API的RESTful接口，提供实体CRUD操作、汇总查询及灵活查询语法，支持基础认证，适用于Shotgun项目管理系统集成的开发场景。
1 次收藏下载次数: 0状态：自动构建维护者：brandonvfx仓库类型：镜像最近更新：8 年前
让 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 无法访问外链，可 打开说明文档 复制全文粘贴。文档会随站点更新，复制内容可能过期，建议定期检查。
SG Restful - WIP
https://travis-ci.org/brandonvfx/sg-restful.svg?branch=master](https://travis-ci.org/brandonvfx/sg-restful) https://img.shields.io/docker/build/brandonvfx/sg-restful.svg](https://hub.docker.com/r/brandonvfx/sg-restful)
SG Restful是Shotgun API的RESTful接口，用于简化与Shotgun项目管理系统的交互。
Docker
标签
0.6.0-beta.1,latest0.5.2-beta.1
部署示例
bashdocker run -e SG_HOST=<你的Shotgun服务器地址> -p 8000:8000 brandonvfx/sg-restful
核心接口端点
- 按ID查询：
GET /[实体类型]/[ID] - 查询所有实体：
GET /[实体类型] - 数据汇总：
GET /[实体类型]/summarize - 创建实体：
POST /[实体类型] - 更新实体：
PATCH /[实体类型]/[ID] - 删除实体：
DELETE /[实体类型]/[ID]
认证机制
SG Restful采用基础认证获取凭据（未来可能优化）：
- 脚本认证头：
Basic <base64编码的script_name:script_key> - 用户认证头：
Basic-User <base64编码的user_name:user_password>（建议通过HTTPS或内部服务器使用）
查询参数
读取操作
page：结果页码（整数）limit：每页结果数（整数）fields：返回字段列表（逗号分隔）q：查询语句（语法见下文）
汇总操作
q：查询语句summaries：汇总配置（JSON数组，含field和type）groupings：分组配置（JSON数组，含field、direction、type）
查询语法
过滤器格式：[<字段名>, <关系>, <值>]
支持三种查询格式：
- 逻辑组合：
q=and([...],[...])或q=or([...],[...]) - JSON结构：
q={"logical_operator":"and", "conditions":[[...]]} - 默认AND组合：
q=[[...],[...]]
测试说明
- 测试需通过
script/test运行（依赖testify模拟数据） - 生成测试日志：设置
SG-RESTFUL_LOG_TO_FILE="yes"，日志文件格式为sg-restful-test.<时间戳>.log
示例：env SG-RESTFUL_LOG_TO_FILE="yes" script/test
镜像拉取方式
您可以使用以下命令拉取该镜像。请将 <标签> 替换为具体的标签版本。如需查看所有可用标签版本，请访问 标签列表页面。
轩辕镜像加速拉取命令点我查看更多 sg-restful 镜像标签
docker pull docker.xuanyuan.run/brandonvfx/sg-restful:<标签>
DockerHub 原生拉取命令
docker pull brandonvfx/sg-restful:<标签>
镜像拉取常见问题
功能
错误码
用户好评
来自真实用户的反馈，见证轩辕镜像的优质服务
oldzhang
运维工程师
Linux服务器
5
"Docker访问体验非常流畅，大镜像也能快速完成下载。"