jgopsill/swapiql

SWAPIQL

Star Wars REST API（SWAPI）的GraphQL包装器服务，将REST接口转换为GraphQL格式，方便用户获取星战相关数据。该服务使用Go编写，并提供Docker镜像供快速部署。

!GitHub !GitHub go.mod Go version

!Docker Cloud Automated build !Docker Cloud Build Status !Docker Image Size (tag) !Docker Pulls

镜像概述

SWAPIQL是SWAPI REST API的代理服务，解决了用户需访问多个REST端点整合星战数据的问题。服务暴露3000端口，GraphQL端点位于根路径（localhost:3000/graphql），同时内置GraphQL Playground（调试查询）和Voyager（schema可视化）工具，便于快速上手。

核心功能

1. GraphQL格式转换：将SWAPI的REST数据转换为GraphQL，支持灵活的按需查询。
2. 可视化工具：提供Playground（localhost:3000/playground）和Voyager（localhost:3000/voyager），简化调试与schema查看。
3. 自定义端点：通过GQL_PREFIX环境变量设置端点前缀（如/swapiql）。
4. 日志控制：设置GQL_DEBUG=true开启调试日志（默认info级别）。
5. 响应缓存：使用go-cache减少重复调用SWAPI的次数，提升性能。

使用场景

• 星战爱好者：快速查询角色、星球、飞船等星战相关数据。
• 开发人员：将星战数据集成到应用中，简化数据获取流程。
• 学习案例：了解REST转GraphQL服务的实现方式。

配置说明

环境变量

• GQL_PREFIX：自定义端点前缀（例如/swapiql，则端点变为localhost:3000/swapiql/graphql）。
• GQL_DEBUG：是否开启调试日志（值为true时启用）。

部署示例

Docker Run

bash
docker run -p 3000:3000 jgopsill/swapiql

Docker Compose（示例）

yaml
version: "3"
services:
  swapiql:
    image: jgopsill/swapiql
    ports:
      - "3000:3000"
    environment:
      - GQL_PREFIX=/swapiql  # 可选：设置端点前缀
      - GQL_DEBUG=true       # 可选：开启调试日志

常用命令

1. 运行Docker镜像：

bash
docker run -p 3000:3000 jgopsill/swapiql

2. 本地运行代码（需先克隆仓库）：

bash
go run main.go

3. 调试模式运行代码：

bash
GQL_DEBUG=true go run main.go

4. 构建Docker镜像：

bash
DOCKER_BUILDKIT=1 docker build --tag swapiql .

（注：DOCKER_BUILDKIT变量会在构建后移除中间镜像）

待办事项

• 完成包装器首次解析（已完成）
• 文档化schema（已完成）
• 添加搜索功能（已完成）
• 缓存功能（已完成）
• 测试与错误处理

参考链接

• https://github.com/GoogleContainerTools/distroless
• 创建轻量安全的Golang Docker镜像
• https://github.com/graph-gophers/graphql-go
• SWAPI - Star Wars API
• GraphQL
• Docker BuildKit
• Watchtower
• https://github.com/rs/zerolog
• https://github.com/patrickmn/go-cache
• https://github.com/graphql/graphql-playground
• https://github.com/APIs-guru/graphql-voyager