degraphql
degraphql 插件通过将 GraphQL 查询映射到 HTTP 端点，支持使用常规 HTTP 请求与上游 GraphQL 服务通信。
示例
以 下示例使用 Pokemon GraphQL API 作为上游 GraphQL 服务器，并演示如何配置 degraphql 来转换不同类型的 GraphQL 查询。
转换基本查询
以下示例演示了如何转换下面的简单查询：
query {
getAllPokemon {
key
color
}
}
- Admin API
- ADC
- Ingress Controller
创建一个启用 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": "/v8",
"upstream": {
"type": "roundrobin",
"nodes": {
"graphqlpokemon.favware.tech": 1
},
"scheme": "https",
"pass_host": "node"
},
"plugins": {
"degraphql": {
"query": "{\n getAllPokemon {\n key\n color\n }\n}"
}
}
}'
创建一个启用 degraphql 插件的路由，如下所示：
adc.yaml
services:
- name: degraphql-service
routes:
- name: degraphql-route
methods:
- POST
uris:
- /v8
plugins:
degraphql:
query: |
{
getAllPokemon {
key
color
}
}
upstream:
type: roundrobin
nodes:
- host: graphqlpokemon.favware.tech
port: 443
weight: 1
scheme: https
将配置同步到网关：
adc sync -f adc.yaml
- Gateway API
- APISIX CRD
degraphql-ic.yaml
apiVersion: v1
kind: Service
metadata:
namespace: aic
name: graphql-pokemon
spec:
type: ExternalName
externalName: graphqlpokemon.favware.tech
---
apiVersion: apisix.apache.org/v1alpha1
kind: BackendTrafficPolicy
metadata:
namespace: aic
name: graphql-pokemon-https
spec:
targetRefs:
- name: graphql-pokemon
kind: Service
group: ""
passHost: node
scheme: https
---
apiVersion: apisix.apache.org/v1alpha1
kind: PluginConfig
metadata:
namespace: aic
name: degraphql-plugin-config
spec:
plugins:
- name: degraphql
config:
query: |
{
getAllPokemon {
key
color
}
}
---
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
namespace: aic
name: degraphql-route
spec:
parentRefs:
- name: apisix
rules:
- matches:
- path:
type: Exact
value: /v8
method:
- POST
filters:
- type: ExtensionRef
extensionRef:
group: apisix.apache.org
kind: PluginConfig
name: degraphql-plugin-config
backendRefs:
- name: graphql-pokemon
port: 443
degraphql-ic.yaml
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
namespace: aic
name: degraphql-route
spec:
ingressClassName: apisix
http:
- name: degraphql-route
match:
paths:
- /v8
methods:
- POST
upstreams:
- name: graphql-pokemon
plugins:
- name: degraphql
enable: true
config:
query: |
{
getAllPokemon {
key
color
}
}
---
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
namespace: aic
name: graphql-pokemon
spec:
ingressClassName: apisix
externalNodes:
- type: Domain
name: graphqlpokemon.favware.tech
port: 443
scheme: https
passHost: node
将配置应用到集群：
kubectl apply -f degraphql-ic.yaml
向路由发送请求进行验证：
curl "http://127.0.0.1:9080/v8" -X POST
你应该会看到类似以下的响应：
{
"data": {
"getAllPokemon": [
{ "key": "pokestarsmeargle", "color": "White" },
{ "key": "pokestarufo", "color": "White" },
{ "key": "pokestarufo2", "color": "White" },
...
{ "key": "terapagosstellar", "color": "Blue" },
{ "key": "pecharunt", "color": "Purple" }
]
}
}
转换带变量的查询
以下示例演示了如何转换下面带有变量的查询：
query ($pokemon: PokemonEnum!) {
getPokemon(
pokemon: $pokemon
) {
color
species
}
}
variable:
{
"pokemon": "pikachu"
}
- Admin API
- ADC
- Ingress Controller
创建一个启用 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": "/v8",
"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"]
}
}
}'
创建一个启用 degraphql 插件的路由，如下所示：
adc.yaml
services:
- name: degraphql-service
routes:
- name: degraphql-route
uris:
- /v8
plugins:
degraphql:
query: |
query ($pokemon: PokemonEnum!) {
getPokemon(
pokemon: $pokemon
) {
color
species
}
}
variables:
- pokemon
upstream:
type: roundrobin
nodes:
- host: graphqlpokemon.favware.tech
port: 443
weight: 1
scheme: https
将配置同步到网关：
adc sync -f adc.yaml
- Gateway API
- APISIX CRD
degraphql-ic.yaml
apiVersion: v1
kind: Service
metadata:
namespace: aic
name: graphql-pokemon
spec:
type: ExternalName
externalName: graphqlpokemon.favware.tech
---
apiVersion: apisix.apache.org/v1alpha1
kind: BackendTrafficPolicy
metadata:
namespace: aic
name: graphql-pokemon-https
spec:
targetRefs:
- name: graphql-pokemon
kind: Service
group: ""
passHost: node
scheme: https
---
apiVersion: apisix.apache.org/v1alpha1
kind: PluginConfig
metadata:
namespace: aic
name: degraphql-plugin-config
spec:
plugins:
- name: degraphql
config:
query: |
query ($pokemon: PokemonEnum!) {
getPokemon(
pokemon: $pokemon
) {
color
species
}
}
variables:
- pokemon
---
apiVersion: gateway.networking.k8s.io/v1
kind: HTTPRoute
metadata:
namespace: aic
name: degraphql-route
spec:
parentRefs:
- name: apisix
rules:
- matches:
- path:
type: Exact
value: /v8
filters:
- type: ExtensionRef
extensionRef:
group: apisix.apache.org
kind: PluginConfig
name: degraphql-plugin-config
backendRefs:
- name: graphql-pokemon
port: 443
degraphql-ic.yaml
apiVersion: apisix.apache.org/v2
kind: ApisixRoute
metadata:
namespace: aic
name: degraphql-route
spec:
ingressClassName: apisix
http:
- name: degraphql-route
match:
paths:
- /v8
upstreams:
- name: graphql-pokemon
plugins:
- name: degraphql
enable: true
config:
query: |
query ($pokemon: PokemonEnum!) {
getPokemon(
pokemon: $pokemon
) {
color
species
}
}
variables:
- pokemon
---
apiVersion: apisix.apache.org/v2
kind: ApisixUpstream
metadata:
namespace: aic
name: graphql-pokemon
spec:
ingressClassName: apisix
externalNodes:
- type: Domain
name: graphqlpokemon.favware.tech
port: 443
scheme: https
passHost: node
将配置应用到集群：
kubectl apply -f degraphql-ic.yaml
向路由发送请求进行验证：
curl "http://127.0.0.1:9080/v8" -X POST \
-d '{
"pokemon": "pikachu"
}'
你应该会看到类似以下的响应：
{
"data": {
"getPokemon": {
"color": "Yellow",
"species": "pikachu"
}
}
}
或者，你也可以在 GET 请求的 URL 查询字符串中传递变量：
curl "http://127.0.0.1:9080/v8?pokemon=pikachu" -H "x-apollo-operation-name: GET"
你应该看到与之前相同的响应。