grpc-transcode

APISIX 接收 HTTP 请求后，首先对请求进行转码，并将转码后的请求转发到 gRPC 服务，获取响应并以 HTTP 格式将其返回给客户端。

类型有效值
enum as resultenum_as_name, enum_as_value
int64 as resultint64_as_number, int64_as_string, int64_as_hexstring
default valuesauto_default_values, no_default_values, use_default_values, use_default_metatable
hooksenable_hooks, disable_hooks

在启用插件之前，你必须将 .proto 或 .pb 文件的内容添加到 APISIX。

可以使用 /admin/proto/id 接口将文件的内容添加到 content 字段：

如果你的 .proto 文件包含 import，或者想要把多个 .proto 文件合并成一个 proto，你可以生成一个 .pb 文件并在 APISIX 中使用它。

假设已经有一个 .proto 文件（proto/helloworld.proto），它导入了另一个 proto 文件：

  1. syntax = "proto3";
  3. package helloworld;
  4. import "proto/import.proto";
  5. ...

首先，让我们从 .proto 文件创建一个 .pb 文件。

  1. protoc --include_imports --descriptor_set_out=proto.pb proto/helloworld.proto

然后将 proto.pb 的内容作为 proto 的 content 字段提交。

由于 proto 的内容是二进制的，我们需要使用以下 Python 脚本将其转换成 base64：

  1. #!/usr/bin/env python
  2. # coding: utf-8
  4. import base64
  5. import sys
  7. # sudo pip install requests
  8. import requests
  10. if len(sys.argv) <= 1:
  11.     print("bad argument")
  12.     sys.exit(1)
  13. with open(sys.argv[1], 'rb') as f:
  14.     content = base64.b64encode(f.read())
  15. id = sys.argv[2]
  16. api_key = "edd1c9f034335f136f87ad84b625c8f1" # use your API key
  18.     "content": content,
  19. }
  20. resp = requests.put("http://127.0.0.1:9080/apisix/admin/proto/" + id, json=reqParam, headers={
  21.     "X-API-KEY": api_key,
  22. })
  23. print(resp.status_code)
  24. print(resp.text)

该脚本将使用 .pb 文件和要创建的 id，将 proto 的内容转换成 base64，并使用转换后的内容调用 Admin API。

运行脚本：

返回结果：

  1. # 200
  2. # {"node":{"value":{"create_time":1643879753,"update_time":1643883085,"content":"CmgKEnByb3RvL2ltcG9ydC5wcm90bxIDcGtnIhoKBFVzZXISEgoEbmFtZRgBIAEoCVIEbmFtZSIeCghSZXNwb25zZRISCgRib2R5GAEgASgJUgRib2R5QglaBy4vcHJvdG9iBnByb3RvMwq9AQoPcHJvdG8vc3JjLnByb3RvEgpoZWxsb3dvcmxkGhJwcm90by9pbXBvcnQucHJvdG8iPAoHUmVxdWVzdBIdCgR1c2VyGAEgASgLMgkucGtnLlVzZXJSBHVzZXISEgoEYm9keRgCIAEoCVIEYm9keTI5CgpUZXN0SW1wb3J0EisKA1J1bhITLmhlbGxvd29ybGQuUmVxdWVzdBoNLnBrZy5SZXNwb25zZSIAQglaBy4vcHJvdG9iBnByb3RvMw=="},"key":"\/apisix\/proto\/1"},"action":"set"}

现在我们可以在指定路由中启用 grpc-transcode 插件：

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1 \
  2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  3. {
  4.     "methods": ["GET"],
  5.     "uri": "/grpctest",
  6.     "plugins": {
  7.         "grpc-transcode": {
  8.          "proto_id": "1",
  9.          "service": "helloworld.Greeter",
  10.          "method": "SayHello"
  11.         }
  12.     },
  13.     "upstream": {
  14.         "scheme": "grpc",
  15.         "type": "roundrobin",
  16.         "nodes": {
  18.         }
  19.     }
  20. }'
note

可以使用 进行测试。

通过上述示例配置插件后，你可以向 APISIX 发出请求以从 gRPC 服务（通过 APISIX）获得响应：

访问上面配置的 route：

  1. curl -i http://127.0.0.1:9080/grpctest?name=world

返回结果

你也可以配置 pb_option，如下所示：

  1. {
  2.     "methods": ["GET"],
  3.     "uri": "/zeebe/WorkflowInstanceCreate",
  4.     "plugins": {
  5.         "grpc-transcode": {
  6.             "proto_id": "1",
  7.             "service": "gateway_protocol.Gateway",
  8.             "method": "CreateWorkflowInstance",
  9.             "pb_option":["int64_as_string"]
  10.         }
  11.     },
  12.     "upstream": {
  13.         "scheme": "grpc",
  14.         "type": "roundrobin",
  15.         "nodes": {
  16.             "127.0.0.1:26500": 1
  17.         }
  18.     }
  19. }'

可以通过如下命令检查刚刚配置的路由：

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