grpc-transcode
#
NameHTTP(s) -> APISIX -> gRPC server
#
Proto#
Attributescontent
:.proto
file's content.
#
Add a protoHere's an example, adding a proto which id
is 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; }"}'
#
Attribute ListName | Type | Requirement | Default | Valid | Description |
---|---|---|---|---|---|
proto_id | string/integer | required | .proto content id. | ||
service | string | required | the grpc service name. | ||
method | string | required | the method name of grpc service. | ||
deadline | number | optional | 0 | deadline for grpc, ms | |
pb_option | array[string(pb_option_def)] | optional | protobuf options |
#
How To EnableHere's an example, to enable the grpc-transcode plugin to specified route:
- attention: the
scheme
in the route's upstream must begrpc
- the grpc server example: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 } }}'
#
Test PluginThe above configuration proxy:
curl -i http://127.0.0.1:9080/grpctest?name=world
response:
HTTP/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"}
This means that the proxying is working.
#
Use pb_option option of grpc-transcode plugin#
option listenum as result
- enum_as_name
- enum_as_value
int64 as result
- int64_as_number
- int64_as_string
- int64_as_hexstring
default values option
- auto_default_values
- no_default_values
- use_default_values
- use_default_metatable
hooks option
- 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 } }}'
#
Test pb_optionVisit configured 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"
suggests pb_option configuration success.
#
Disable PluginRemove the corresponding json configuration in the plugin configuration to disable grpc-transcode
.
APISIX plugins are hot-reloaded, therefore no need to restart 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 } }}'