Implement Web Method Caching

Web method caching is an effective way to improve the performance of your site by temporarily storing the return values of web methods in a cache. This article guides you through the process of implementing web method caching and how to invalidate it when necessary.

Step 1 | Set up caches

You must assign identifiers to cached return values of your web methods and can optionally define a cache's Time To Live (TTL). These required identifiers, called tags, allow you to easily identify caches that may need invalidation. For example, you can invalidate all caches that have the tag "math."

To set up caching for your web methods:

1. Open your web modules and find the methods you want to cache.

2. For each web method that you want to cache, update the code so that the webMethod() is called with the following options:

• cache: An object containing:

  • tags: One or more identifiers of the cached return value.
  • ttl: The cache's time-to-live in seconds. If omitted, defaults to 1 week (604800 seconds).
  Copy

Step 2 | Invalidate caches

Invalidating or clearing your caches causes your backend methods to re-execute upon the following request, ensuring that fresh data is retrieved and cached.

To invalidate caches, use the invalidateCache() method from the wix-cache-backend module. This method accepts the invalidationMethods parameter, which specifies the tags previously assigned to the caches you want to invalidate.

To invalidate caches:

1. Add the necessary imports in your web modules (backend files).

   Copy

2. Create a variable to store the tags assigned to the cache. Then call elevate() and store its returned value in another variable.

   Copy

3. Call webMethod() and store its return value in an exported variable. Pass a permissions value and the elevated invalidation method.

   Copy

See also

• About Caching
• About Web Method Caching
• About Web Modules
• wix-web-module API
• wix-cache-backend API