跳到主要内容

degraphql

degraphql 插件通过将 GraphQL 查询映射到 HTTP 端点，支持使用常规 HTTP 请求与上游 GraphQL 服务通信。

示例​

以下示例使用 Pokemon GraphQL API 作为上游 GraphQL 服务器，并演示如何配置 degraphql 来转换不同类型的 GraphQL 查询。

转换基本查询​

以下示例演示了如何转换下面的简单查询：

query {
  getAllPokemon {
    key
    color
  }
}

创建一个启用 degraphql 插件的路由，如下所示：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_KEY}" \
  -d '{
    "id": "degraphql-route",
    "methods": ["POST"],
    "uri": "/v7",
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "graphqlpokemon.favware.tech": 1
      },
      "scheme": "https",
      "pass_host": "node"
    },
    "plugins": {
      "degraphql": {
        "query": "{\n  getAllPokemon {\n    key\n    color\n  }\n}"
      }
    }
  }'

发送请求到路由以进行验证：

curl "http://127.0.0.1:9080/v7" -X POST

你应该会看到类似以下的响应：

{
  "data": {
    "getAllPokemon": [
      { "key": "pokestarsmeargle", "color": "White" },
      { "key": "pokestarufo", "color": "White" },
      { "key": "pokestarufo2", "color": "White" },
      ...
      { "key": "walkingwake", "color": "Blue" },
      { "key": "ironleaves", "color": "Green" }
    ]
  }
}

转换带变量的查询​

以下示例演示了如何转换下面带有变量的查询：

query ($pokemon: PokemonEnum!) {
  getPokemon(
    pokemon: $pokemon
  ) {
    color
    species
  }
}

variable:
{
  "pokemon": "pikachu"
}

创建一个启用 degraphql 插件的路由，如下所示：

curl "http://127.0.0.1:9180/apisix/admin/routes" -X PUT \
  -H "X-API-KEY: ${ADMIN_API_KEY}" \
  -d '{
    "id": "degraphql-route",
    "uri": "/v7",
    "upstream": {
      "type": "roundrobin",
      "nodes": {
        "graphqlpokemon.favware.tech": 1
      },
      "scheme": "https",
      "pass_host": "node"
    },
    "plugins": {
      "degraphql": {
        "query": "query ($pokemon: PokemonEnum!) {\n  getPokemon(\n    pokemon: $pokemon\n  ) {\n    color\n    species\n  }\n}\n",
        "variables": ["pokemon"]
      }
    }
  }'

发送请求到路由以进行验证：

curl "http://127.0.0.1:9080/v7" -X POST \
  -d '{
    "pokemon": "pikachu"
  }'

你应该会看到类似以下的响应：

{
  "data": {
    "getPokemon": {
      "color": "Yellow",
      "species": "pikachu"
    }
  }
}

或者，你也可以在 GET 请求的 URL 查询字符串中传递变量：

curl "http://127.0.0.1:9080/v7?pokemon=pikachu" -H "x-apollo-operation-name: GET"

你应该看到与之前相同的响应。