This plugin will protect the client from consuming API responses that are deemed too large within the Kong API Gateway.
- Plugin enables Kong users to specify the size in MB that they will allow for API response sizes.
If transaction response is deemed too large the Gateway will throw an HTTP Status of 413 and a response body of "Response size limit exceeded"
Kong >= 1.0
Recommended:
$ luarocks install kong-response-size-limiting
Other:
$ git clone https://github.com/Optum/kong-response-size-limiting.git /path/to/kong/plugins/kong-response-size-limiting
$ cd /path/to/kong/plugins/kong-response-size-limiting
$ luarocks make *.rockspec
This plugin currently accomplishes limiting by validating the Content-Length header on API responses, if backend microservice is lacking such a standard header, then plugin will not response size limit. PRs for additional functionality welcome!
Special thanks to thibaultcha and james-callahan with their suggestions!
Feel free to open issues, or refer to our Contribution Guidelines if you have any questions.