A lightweight caching library which leverages FastAPI's middleware functionality and follows best practices of cache-control to easily speed up your large requests.

N.B: Only GET requests get cached

1. The packages can be included in your project by running
   `pip install cache-fastapi

2. Add REDIS_URL in your environment, the caching middleware will use this to store responses

3. To get started you need to import the cache-fastapi middleware and then add it to your FastAPI app
   

   from fastapi import FastAPI
   from cache_fastapi.cacheMiddleware import CacheMiddleware
   
   cached_endpoints = [
       "/test"
   ]
   
   app = FastAPI()
   app.add_middleware(CacheMiddleware, cached_endpoints=cached_endpoints)
   

   For nested routes just add the base route: For example if you have routes /data/{data_id}, you can just add /data/ to the cached_endpointslist

   cached_endpoints = [
       "/test",
       "/data/"
   ]
   

4. The cached_endpoints can be used to define all the endpoints you want to cache. This gives you can central place where you can keep track of all the cached endpoints.

5. The default cache max-age is 60 secs, to overwrite that in the API request send the following header
   Cache-Control: max-age=time
   Here time needs to be in seconds.

6. Once a response is cached, you'll be able to get the cached response age in the response header Cache-Control

7. To overwrite the cache and get a fresh response use
   Cache-Control: no-cache

8. If you want to make a request and do not want that request to be considered for caching you can use
   Cache-Control: no-store