grpc-transcode

HTTP(s) -> APISIX -> gRPC server

Proto

参数

  • content: .proto 文件的内容

添加proto

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

  1. curl http://127.0.0.1:9080/apisix/admin/proto/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "content" : "syntax = \"proto3\";
  4.     package helloworld;
  5.     service Greeter {
  6.         rpc SayHello (HelloRequest) returns (HelloReply) {}
  7.     }
  8.     message HelloRequest {
  9.         string name = 1;
  10.     }
  11.     message HelloReply {
  12.         string message = 1;
  13.     }"
  14. }'

参数列表

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

示例

使用 grpc-transcode 插件

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

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

测试

访问上面配置的 route：

  1. $ curl -i http://127.0.0.1:9080/grpctest?name=world
  2. HTTP/1.1 200 OK
  3. Date: Fri, 16 Aug 2019 11:55:36 GMT
  4. Content-Type: application/json
  5. Transfer-Encoding: chunked
  6. Connection: keep-alive
  7. Server: APISIX web server
  8. Proxy-Connection: keep-alive
  10. {"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
  1. curl http://127.0.0.1:9080/apisix/admin/routes/23 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "methods": ["GET"],
  4.     "uri": "/zeebe/WorkflowInstanceCreate",
  5.     "plugins": {
  6.         "grpc-transcode": {
  7.             "proto_id": "1",
  8.             "service": "gateway_protocol.Gateway",
  9.             "method": "CreateWorkflowInstance",
  10.             "pb_option":["int64_as_string"]
  11.         }
  12.     },
  13.     "upstream": {
  14.         "scheme": "grpc",
  15.         "type": "roundrobin",
  16.         "nodes": {
  17.             "127.0.0.1:26500": 1
  18.         }
  19.     }
  20. }'

测试 pb_option 参数

访问上面配置的 route：

  1. $ curl -i "http://127.0.0.1:9080/zeebe/WorkflowInstanceCreate?bpmnProcessId=order-process&version=1&variables=\{\"orderId\":\"7\",\"ordervalue\":99\}"
  2. HTTP/1.1 200 OK
  3. Date: Wed, 13 Nov 2019 03:38:27 GMT
  4. Content-Type: application/json
  5. Transfer-Encoding: chunked
  6. Connection: keep-alive
  7. grpc-encoding: identity
  8. grpc-accept-encoding: gzip
  9. Server: APISIX web server
  10. Trailer: grpc-status
  11. Trailer: grpc-message
  13. {"workflowKey":"#2251799813685260","workflowInstanceKey":"#2251799813688013","bpmnProcessId":"order-process","version":1}

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

禁用插件

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

  1. curl http://127.0.0.1:9080/apisix/admin/routes/111 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/grpctest",
  4.     "plugins": {},
  5.     "upstream": {
  6.         "scheme": "grpc",
  7.         "type": "roundrobin",
  8.         "nodes": {
  9.             "127.0.0.1:50051": 1
  10.         }
  11.     }
  12. }'