gzip
描述#
gzip 插件能动态设置 Nginx 的压缩行为。
该插件要求 APISIX 运行在 APISIX-OpenResty 上。
属性#
| 名称 | 类型 | 必选项 | 默认值 | 有效值 | 描述 |
|---|---|---|---|---|---|
| types | array[string] or "*" | 可选 | ["text/html"] | 动态设置 gzip_types 指令，特殊值 "*" 匹配任何 MIME 类型 | |
| min_length | integer | 可选 | 20 | >= 1 | 动态设置 gzip_min_length 指令 |
| comp_level | integer | 可选 | 1 | [1, 9] | 动态设置 gzip_comp_level 指令 |
| http_version | number | 可选 | 1.1 | 1.1, 1.0 | 动态设置 gzip_http_version 指令 |
| buffers.number | integer | 可选 | 32 | >= 1 | 动态设置 gzip_buffers 指令 |
| buffers.size | integer | 可选 | 4096 | >= 1 | 动态设置 gzip_buffers 指令 |
| vary | boolean | 可选 | false | 动态设置 gzip_vary 指令 |
如何启用#
下面是一个示例，在指定的 route 上开启了 gzip 插件：
curl -i http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{ "uri": "/index.html", "plugins": { "gzip": { "buffers": { "number": 8 } } }, "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } }}'测试插件#
使用 curl 访问：
curl http://127.0.0.1:9080/index.html -i -H "Accept-Encoding: gzip"HTTP/1.1 404 Not FoundContent-Type: text/html; charset=utf-8Transfer-Encoding: chunkedConnection: keep-aliveDate: Wed, 21 Jul 2021 03:52:55 GMTServer: APISIX/2.7Content-Encoding: gzip
Warning: Binary output can mess up your terminal. Use "--output -" to tellWarning: curl to output it to your terminal anyway, or consider "--outputWarning: <FILE>" to save to a file.禁用插件#
想要禁用该插件时很简单，在路由 plugins 配置块中删除对应 JSON 配置，不需要重启服务，即可立即生效禁用该插件。
curl http://127.0.0.1:9080/apisix/admin/routes/1 -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{ "uri": "/index.html", "upstream": { "type": "roundrobin", "nodes": { "127.0.0.1:1980": 1 } }}'