Skip to main content
Version: 2.10

grpc-transcode

HTTP(s) -> APISIX -> gRPC server

Proto#

参数#

  • content: .proto 文件的内容

添加proto#

路径中最后的数字，会被用作 proto 的 id 做唯一标识，比如下面示例的 proto id 是 1 ：

curl http://127.0.0.1:9080/apisix/admin/proto/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "content" : "syntax = \"proto3\";    package helloworld;    service Greeter {        rpc SayHello (HelloRequest) returns (HelloReply) {}    }    message HelloRequest {        string name = 1;    }    message HelloReply {        string message = 1;    }"}'

参数列表#

名称类型必选项默认值有效值描述
proto_idstring/integer必须.proto 内容的 id
servicestring必须grpc 服务名
methodstring必须grpc 服务中要调用的方法名
deadlinenumber可选0grpc deadline, ms
pb_optionarray[string(pb_option_def)]可选proto 编码过程中的转换选项

示例#

使用 grpc-transcode 插件#

在指定 route 中，代理 grpc 服务接口:

  • 注意： 这个 route 对应的 upstream 的属性 scheme 必须设置为 grpc
  • 代理 grpc 服务例子可参考：grpc_server_example
curl http://127.0.0.1:9080/apisix/admin/routes/111 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "methods": ["GET"],    "uri": "/grpctest",    "plugins": {        "grpc-transcode": {         "proto_id": "1",         "service": "helloworld.Greeter",         "method": "SayHello"        }    },    "upstream": {        "scheme": "grpc",        "type": "roundrobin",        "nodes": {            "127.0.0.1:50051": 1        }    }}'

测试#

访问上面配置的 route：

$ curl -i http://127.0.0.1:9080/grpctest?name=worldHTTP/1.1 200 OKDate: Fri, 16 Aug 2019 11:55:36 GMTContent-Type: application/jsonTransfer-Encoding: chunkedConnection: keep-aliveServer: APISIX web serverProxy-Connection: keep-alive
{"message":"Hello world"}

这表示已成功代理。

使用 grpc-transcode 插件的 pb_option 选项#

在指定 route 中，代理 grpc 服务接口:

选项清单#

  • 枚举类型

    • enum_as_name
    • enum_as_value

  • 64位整型

    • int64_as_number
    • int64_as_string
    • int64_as_hexstring

  • 使用默认值

    • auto_default_values
    • no_default_values
    • use_default_values
    • use_default_metatable

  • Hooks开关

    • enable_hooks
    • disable_hooks
curl http://127.0.0.1:9080/apisix/admin/routes/23 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "methods": ["GET"],    "uri": "/zeebe/WorkflowInstanceCreate",    "plugins": {        "grpc-transcode": {            "proto_id": "1",            "service": "gateway_protocol.Gateway",            "method": "CreateWorkflowInstance",            "pb_option":["int64_as_string"]        }    },    "upstream": {        "scheme": "grpc",        "type": "roundrobin",        "nodes": {            "127.0.0.1:26500": 1        }    }}'

测试 pb_option 参数#

访问上面配置的 route：

$ curl -i "http://127.0.0.1:9080/zeebe/WorkflowInstanceCreate?bpmnProcessId=order-process&version=1&variables=\{\"orderId\":\"7\",\"ordervalue\":99\}"HTTP/1.1 200 OKDate: Wed, 13 Nov 2019 03:38:27 GMTContent-Type: application/jsonTransfer-Encoding: chunkedConnection: keep-alivegrpc-encoding: identitygrpc-accept-encoding: gzipServer: APISIX web serverTrailer: grpc-statusTrailer: grpc-message
{"workflowKey":"#2251799813685260","workflowInstanceKey":"#2251799813688013","bpmnProcessId":"order-process","version":1}

"workflowKey":"#2251799813685260" 表示已成功。

禁用插件#

在插件设置页面中删除相应的 json 配置即可禁用 grpc-transcode 插件。APISIX 的插件是热加载的，因此无需重启 APISIX 服务。

curl http://127.0.0.1:9080/apisix/admin/routes/111 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "uri": "/grpctest",    "plugins": {},    "upstream": {        "scheme": "grpc",        "type": "roundrobin",        "nodes": {            "127.0.0.1:50051": 1        }    }}'