proxy-control

Description

The proxy-control plugin dynamically controls the behavior of Nginx to proxy.

This plugin requires APISIX to run on APISIX-Base.

Attributes

NameTypeRequirementDefaultValidDescription
request_bufferingbooleanoptionaltruedynamically set the proxy_request_buffering directive

How To Enable

Here’s an example, enable this plugin on the specified route:

  1. curl -i http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/upload",
  4.     "plugins": {
  5.         "proxy-control": {
  6.             "request_buffering": false
  7.         }
  8.     },
  9.     "upstream": {
  10.         "type": "roundrobin",
  11.         "nodes": {
  12.             "127.0.0.1:1980": 1
  13.         }
  14.     }
  15. }'

Test Plugin

Use curl to access:

  1. curl -i http://127.0.0.1:9080/upload -d @very_big_file

It’s expected not to find “a client request body is buffered to a temporary file” in the error log.

Disable Plugin

When you want to disable this plugin, it is very simple, you can delete the corresponding json configuration in the plugin configuration, no need to restart the service, it will take effect immediately:

  1. curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
  2. {
  3.     "uri": "/upload",
  4.     "upstream": {
  5.         "type": "roundrobin",
  6.         "nodes": {
  7.             "127.0.0.1:1980": 1
  8.         }
  9.     }
  10. }'

This plugin has been disabled now. It works for other plugins.