proxy-cache

    基于磁盘的缓存需要注意：

    1. 不能动态配置缓存的过期时间，只能通过后端服务响应头 Expires 或 Cache-Control 来设置过期时间，如果后端响应头中没有 Expires 或 Cache-Control，那么 APISIX 将默认只缓存10秒钟

    注：变量以$开头，也可以使用变量和字符串的结合，但是需要以数组的形式分开写，最终变量被解析后会和字符串拼接在一起。

    在 文件中的配置示例:

    示例

    启用插件

    示例一：cache_zone 参数默认为 disk_cache_one

    1、为特定路由启用 proxy-cache 插件：

    1. curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "plugins": {        "proxy-cache": {            "cache_key":  ["$uri", "-cache-id"],            "cache_bypass": ["$arg_bypass"],            "cache_method": ["GET"],            "cache_http_status": [200],            "hide_cache_headers": true,            "no_cache": ["$arg_test"]        }    },    "upstream": {        "nodes": {            "127.0.0.1:1999": 1        },        "type": "roundrobin"    },    "uri": "/hello"}'

    测试：

    1. $ curl http://127.0.0.1:9080/hello -iHTTP/1.1 200 OKContent-Type: application/octet-streamContent-Length: 6Connection: keep-aliveServer: APISIX web serverDate: Tue, 03 Mar 2020 10:45:36 GMTLast-Modified: Tue, 03 Mar 2020 10:36:38 GMTApisix-Cache-Status: MISS
    2. hello
    1. $ curl http://127.0.0.1:9080/hello -iHTTP/1.1 200 OKContent-Type: application/octet-streamContent-Length: 6Connection: keep-aliveServer: APISIX web serverDate: Tue, 03 Mar 2020 11:14:46 GMTLast-Modified: Thu, 20 Feb 2020 14:21:41 GMTApisix-Cache-Status: HIT

    示例二：自定义 cache_zone 参数为 disk_cache_two

    1、在 conf/config.yaml 文件中的指定缓存区域等信息:

    2、为特定路由启用 proxy-cache 插件：

    1. $ curl http://127.0.0.1:9080/apisix/admin/routes/1  -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '{    "plugins": {        "proxy-cache": {            "cache_zone": "disk_cache_two",            "cache_key":  ["$uri", "-cache-id"],            "cache_bypass": ["$arg_bypass"],            "cache_method": ["GET"],            "cache_http_status": [200],            "hide_cache_headers": true,            "no_cache": ["$arg_test"]        }    },    "upstream": {        "nodes": {            "127.0.0.1:1999": 1        },        "type": "roundrobin"    },    "uri": "/hello"}'

    测试：

    1. hello

    3、验证数据是否被缓存，再次请求上面的地址：

    2. hello

    示例3：指定 cache_zone 为 invalid_disk_cache 与 conf/config.yaml 文件中指定的缓存区域 disk_cache_one 不一致。

    1. {"error_msg":"failed to check the configuration of plugin proxy-cache err: cache_zone invalid_disk_cache not found"}

    响应错误信息，表示插件配置无效。

    清除缓存数据

    如何清理缓存的数据，只需要指定请求的 method 为 PURGE。

    测试：

    1. $ curl -i http://127.0.0.1:9080/hello -X PURGEHTTP/1.1 200 OKDate: Tue, 03 Mar 2020 11:17:35 GMTContent-Type: text/plainTransfer-Encoding: chunkedConnection: keep-aliveServer: APISIX web server

    再次请求，缓存数据未找到返回404：

    1. $ curl -i http://127.0.0.1:9080/hello -X PURGEHTTP/1.1 404 Not FoundDate: Wed, 18 Nov 2020 05:46:34 GMTContent-Type: text/plainTransfer-Encoding: chunkedConnection: keep-aliveServer: APISIX web server

    禁用插件

    移除插件配置中相应的 JSON 配置可立即禁用该插件，无需重启服务：