Blog

ColdBox REST API Caching

Maria Jose Herrera August 19, 2024

Spread the word

Maria Jose Herrera

August 19, 2024

Spread the word


Share your thoughts

Enhance your project performance!

Caching is a powerful technique to boost the performance of your REST API. By reducing server load and speeding up response times, caching enhances the efficiency and scalability of your API. ColdBox offers advanced caching capabilities to optimize your API's performance.

ColdBox comes bundled with the CacheBox framework. CacheBox is an enterprise cache and cache aggregator where you can aggregate different caching engines or types of the same engine into one umbrella. It gives you built-in logging (via LogBox), an event model, synchronization, shutdown/startup procedures, reporting, interaction consoles, and a cache-agnostic API.

Become an Expert

Key Benefits

  • Event Caching: Cache entire responses for specific resources to minimize repeated processing. This reduces the load on your server and improves response times for frequently accessed data.
  • Flexible Configuration: Easily configure cache duration and behavior using annotations and settings. This flexibility lets you fine-tune caching strategies according to your application’s needs.
  • Scalability: CacheBox stores cached data in various backends, including distributed systems like Couchbase clusters. This scalability ensures that your caching solution grows with your application.

Learn More

Implementing Caching in ColdBox

Enhancing performance through caching in ColdBox involves straightforward setup and configuration:

  • Event Caching: Enable caching for specific actions by adding the cache=true annotation.

    function showEntry(event, rc, prc) cache="true" {
        prc.qEntry = getEntryService().getEntry( rc.entryId ?: 0);
    	  return prc.qEntry.getMemento();
    }
    
  • Configuring Cache Settings: Adjust cache duration and behavior to suit your needs.

    function getCachedData(event, rc, prc) cache=true cacheTimeout=60{
        prc.qEntry = getEntryService().getEntry( rc.entryId ?: 0);
    	  return prc.qEntry.getMemento();
    }
    

Join Us

Are you looking to improve the performance of your ColdBox REST APIs? Do you want to learn how to implement effective caching strategies? If so, this is your opportunity to join us at our 2-day ColdBox REST API workshop from September 28-29, 2024 in Las Vegas, Nevada before Adobe CFSummit 2024.

Gain hands-on experience and personalized training to enhance your projects and get more tips and tricks to secure your projects. Register now and start optimizing your APIs for speed and efficiency!

Register NowI

Add Your Comment

Recent Entries

MatchBox and WebAssembly: Running BoxLang in the Browser and at the Edge

MatchBox and WebAssembly: Running BoxLang in the Browser and at the Edge

The MatchBox open beta is live at https://boxlang.ortusbooks.com/boxlang-framework/matchbox, and it brings something genuinely new to the BoxLang ecosystem: a path into WebAssembly.

That means BoxLang code can now move into browser applications, static-site deployments, edge runtimes, and WASI-style containers - without requiring a JVM. The feature is still beta, but the core direction is already useful: write BoxLang, compile it with MatchBox, and ship the generated WASM artifact to wherever a small portable runtime makes sense.

Jacob Beers
Jacob Beers
June 04, 2026