DeGraphQL

功能说明

de-graphql 插件用于将 Restful API 转换为 GraphQL 请求。

GraphQL 简介

GraphQL 端点

REST API 有多个端点，GraphQL API 只有一个端点。

与 GraphQL 通信

由于 GraphQL 操作由多行 JSON 组成，可以使用 curl 或任何其他采用 HTTP 的库。

在 REST 中，HTTP 谓词确定执行的操作。 在 GraphQL 中，执行查询要提供 JSON 请求体，因此 HTTP 谓词为 POST。 唯一的例外是内省查询，它是一种简单的 GET 到终结点查询。

GraphQL POST 请求参数

标准的 GraphQL POST 请求情况如下：

  • 添加 HTTP 请求头： Content-Type: application/json
  • 使用 JSON 格式的请求体
  • JSON 请求体包含三个字段
    • query：查询文档，必填
    • variables：变量，选填
    • operationName：操作名称，选填，查询文档有多个操作时必填
  1. {
      “query”: “{viewer{name}}”,
      “operationName”: “”,
      “variables”: {
        “name”: “value”
      }
    }

GraphQL 基本参数类型

  • 基本参数类型包含： String, Int, Float, Boolean
  • [类型]代表数组，例如：[Int]代表整型数组
  • GraphQL 基本参数传递
    • 小括号内定义形参，注意：参数需要定义类型
    • !（叹号）代表参数不能为空
  1. query ($owner : String!, $name : String!) {
      repository(owner: $owner, name: $name) {
        name
        forkCount
        description
      }
    }

GitHub GraphQL 测试

使用 curl 命令查询 GraphQL， 用有效 JSON 请求体发出 POST 请求。 有效请求体必须包含一个名为 query 的字符串。

  1. -H “Authorization: bearer <PAT>” \
    -d “{\”query\”: \”query { viewer { login }}\”}”
  2. {
      “data”: {
        “viewer”: {
          “login”: “2456868764”
        }
      }
    }
  1. curl ‘https://api.github.com/graphql‘ -X POST \
    -H ‘Authorization: bearer <PAT>’ \
    -d ‘{“query”:”query ($owner: String!, $name: String!) {\n  repository(owner: $owner, name: $name) {\n    name\n    forkCount\n    description\n  }\n}\n”,”variables”:{“owner”:”2456868764”,”name”:”higress”}}’
  2. {
      “data”: {
        “repository”: {
          “name”: “higress”,
          “forkCount”: 149,
          “description”: “Next-generation Cloud Native Gateway | 下一代云原生网关”
        }
      }
    }

DeGraphQL 插件

参数配置

参数描述默认
gqlgraphql 查询不能为空
endpointgraphql 查询端点/graphql
timeout查询连接超时，单位毫秒5000
domain服务域名，当服务来源是dns配置

插件使用

测试配置。

  1. apiVersion: networking.higress.io/v1
    kind: McpBridge
    metadata:
      name: default
      namespace: higress-system
    spec:
      registries:
      - domain: api.github.com
        name: github
        port: 443
        type: dns
    —-
    apiVersion: networking.k8s.io/v1
    kind: Ingress
    metadata:
      annotations:
        higress.io/destination: github.dns
        higress.io/upstream-vhost: “api.github.com”
        higress.io/backend-protocol: HTTPS
      name: github-api
      namespace: higress-system
    spec:
      ingressClassName: higress
      rules:
      - http:
          paths:
          - backend:
              resource:
                apiGroup: networking.higress.io
                kind: McpBridge
                name: default
            path: /api
            pathType: Prefix
    —-
    apiVersion: extensions.higress.io/v1alpha1
    kind: WasmPlugin
    metadata:
      name: de-graphql-github-api
      namespace: higress-system
    spec:
      matchRules:
      - ingress:
        - github-api
        config:
          timeout: 5000
          endpoint: /graphql
          domain: api.github.com
          gql: |
               query ($owner:String! $name:String!){
                  repository(owner:$owner, name:$name) {
                    name
                    forkCount
                    description
                 }
               }
      url: oci://higress-registry.cn-hangzhou.cr.aliyuncs.com/plugins/de-graphql:1.0.0

测试结果。

  1. curl “http://localhost/api?owner=alibaba&name=higress“ -H “Authorization: Bearer some-token”
  2. {
      “data”: {
        “repository”: {
          “description”: “Next-generation Cloud Native Gateway”,
          “forkCount”: 149,
          “name”: “higress”
        }
      }
    }

参考文档