Skip to main content
Version: 3.0.0-beta

dubbo-proxy

Description#

The dubbo-proxy Plugin allows you to proxy HTTP requests to Apache Dubbo.

IMPORTANT

If you are using OpenResty, you need to build it with Dubbo support. See How do I build the APISIX base environment for details.

Runtime Attributes#

NameTypeRequiredDefaultDescription
service_namestringTrueDubbo provider service name.
service_versionstringTrueDubbo provider service version.
methodstringFalseThe path of the URI.Dubbo provider service method.

Static Attributes#

NameTypeRequiredDefaultValid valuesDescription
upstream_multiplex_countnumberTrue32>= 1Maximum number of multiplex requests in an upstream connection.

Enabling the Plugin#

To enable the dubbo-proxy Plugin, you have to add it in your configuration file (conf/config.yaml):

conf/config.yaml
plugins:
- ...
- dubbo-proxy

Now, when APISIX is reloaded, you can add it to a specific Route as shown below:

curl http://127.0.0.1:9180/apisix/admin/upstreams/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"nodes": {
"127.0.0.1:20880": 1
},
"type": "roundrobin"
}'

curl http://127.0.0.1:9180/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"uris": [
"/hello"
],
"plugins": {
"dubbo-proxy": {
"service_name": "org.apache.dubbo.sample.tengine.DemoService",
"service_version": "0.0.0",
"method": "tengineDubbo"
}
},
"upstream_id": 1
}'

Example usage#

You can follow the Quick Start guide in Tengine with the configuration above for testing.

Dubbo returns data in the form Map<String, String>.

If the returned data is:

{
"status": "200",
"header1": "value1",
"header2": "value2",
"body": "body of the message"
}

The converted HTTP response will be:

HTTP/1.1 200 OK
...
header1: value1
header2: value2
...

body of the message

Disable Plugin#

To disable the dubbo-proxy Plugin, you can delete the corresponding JSON configuration from the Plugin configuration. APISIX will automatically reload and you do not have to restart for this to take effect.

curl http://127.0.0.1:9180/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
{
"methods": ["GET"],
"uris": [
"/hello"
],
"plugins": {
},
"upstream_id": 1
}
}'

To completely disable the dubbo-proxy Plugin, you can remove it from your configuration file (conf/config.yaml):

conf/config.yaml
plugins:
# - dubbo-proxy