解决gql库与Shopify GraphQL API集成时的请求格式问题

在使用Python的gql库与Shopify GraphQL API交互时，开发者可能会遇到一个常见的请求格式错误。这个问题源于Shopify GraphQL API的特殊请求格式要求，与标准GraphQL HTTP接口有所不同。

问题现象

当开发者使用gql库向Shopify GraphQL API发送请求时，可能会收到类似以下的错误响应：

syntax error, unexpected STRING ("query") at [1, 2]

查看请求日志会发现，虽然开发者没有在代码中显式添加"query"前缀，但请求中却自动包含了这个前缀。这是因为gql库默认会按照标准GraphQL HTTP接口规范发送请求，而Shopify API需要不同的请求格式。

问题根源

Shopify GraphQL API的请求格式与标准GraphQL HTTP接口有以下关键区别：

1. 标准GraphQL请求格式是直接将查询语句放在"query"键下
2. Shopify API要求将查询语句包装在"graphQLParams"对象中
3. Shopify API还需要额外的"version"参数指定API版本

解决方案

要解决这个问题，我们可以创建一个自定义的Transport类来适配Shopify的特殊格式要求。以下是完整的解决方案实现：

import logging
from gql import gql, Client
from gql.transport.httpx import HTTPXTransport

# 配置日志以便调试
logging.basicConfig(level=logging.INFO)

class ShopifyTransport(HTTPXTransport):
    """自定义Transport类适配Shopify GraphQL API的特殊格式要求"""
    
    def _prepare_request(
        self,
        document,
        variable_values=None,
        operation_name=None,
        extra_args=None,
        upload_files=False,
    ):
        # 首先获取标准的请求payload
        payload = super()._prepare_request(
            document=document,
            variable_values=variable_values,
            operation_name=operation_name,
            extra_args=extra_args,
            upload_files=upload_files,
        )

        # 将标准payload包装成Shopify要求的格式
        shopify_payload = {
            "graphQLParams": payload["json"],
            "version": "2024-01",  # 使用适当的API版本
        }

        return {"json": shopify_payload}

# 创建使用自定义Transport的Client
transport = ShopifyTransport(url="你的Shopify GraphQL端点URL")
client = Client(transport=transport)

# 示例查询
query = gql("""
{
  shop {
    name
  }
}
""")

# 执行查询
result = client.execute(query)
print(f"查询结果: {result}")

实现原理

这个解决方案的核心是自定义Transport类，它继承自HTTPXTransport并重写了_prepare_request方法。该方法负责：

1. 首先调用父类方法获取标准GraphQL请求格式
2. 然后将标准请求包装在"graphQLParams"键下
3. 添加Shopify API要求的"version"参数
4. 返回适配后的请求格式

使用建议

1. 确保使用正确的Shopify GraphQL端点URL
2. 根据Shopify API文档更新"version"参数为适当的值
3. 对于复杂的查询和变更操作，同样适用此解决方案
4. 可以根据需要扩展ShopifyTransport类以添加认证头等其他必要参数

通过这种自定义Transport的方式，开发者可以无缝地将gql库与Shopify GraphQL API集成，而无需修改现有的查询逻辑。这种设计既保持了代码的整洁性，又解决了API兼容性问题。