Installation

1. Add required dependencies

   memory (default)

   yarn add strapi-plugin-rest-cache

   redis

   yarn add \
     strapi-plugin-rest-cache \
     strapi-plugin-redis \
     strapi-provider-rest-cache-redis

   couchbase

   yarn add \
     strapi-plugin-rest-cache \
     strapi-provider-rest-cache-couchbase

   INFO

   This plugin is only compatible with Strapi v4.0.0 and above.
   If you are looking for a plugin for Strapi v3.x, please check the strapi-middleware-cache.

2. Enable the plugin in ./config/plugins.js

   memory (default)

   module.exports = {
     "rest-cache": {
       config: {
         provider: {
           name: "memory",
           options: {
             max: 32767,
             maxAge: 3600,
           },
         },
         strategy: {
           contentTypes: [
             // list of Content-Types UID to cache
             "api::category.category",
             "api::article.article",
             "api::global.global",
             "api::homepage.homepage",
           ],
         },
       },
     },
   };

   redis

   module.exports = {
     // Step 1: Configure the redis connection
     // @see https://github.com/strapi-community/strapi-plugin-redis
     redis: {
       // ...
     },
     // Step 2: Configure the redis cache plugin
     "rest-cache": {
       config: {
         provider: {
           name: "redis",
           options: {
             max: 32767,
             connection: "default",
           },
         },
         strategy: {
           // if you are using keyPrefix for your Redis, please add <keysPrefix>
           keysPrefix: "<redis_keyPrefix>",
           contentTypes: [
             // list of Content-Types UID to cache
             "api::category.category",
             "api::article.article",
             "api::global.global",
             "api::homepage.homepage",
           ],
         },
       },
     },
   };

   couchbase

   module.exports = {
     "rest-cache": {
       config: {
         provider: {
           name: "couchbase",
           max: 32767,
           options: {
             connectionString: "couchbase://127.0.0.1:8091",
             connectionOptions: {
               username: "Administrator",
               password: "couchbase",
             },
             bucket: "test-bucket",
             ttl: 2,
           },
         },
         strategy: {
           contentTypes: [
             // list of Content-Types UID to cache
             "api::category.category",
             "api::article.article",
             "api::global.global",
             "api::homepage.homepage",
           ],
         },
       },
     },
   };