mirror of
				https://github.com/nsnail/Ocelot.git
				synced 2025-11-04 10:35:28 +08:00 
			
		
		
		
	Feature/docs (#165)
* initial readthedocs commit * docs moved to sphinx / rst / read the docs
This commit is contained in:
		
							
								
								
									
										21
									
								
								docs/features/caching.rst
									
									
									
									
									
										Normal file
									
								
							
							
						
						
									
										21
									
								
								docs/features/caching.rst
									
									
									
									
									
										Normal file
									
								
							@@ -0,0 +1,21 @@
 | 
			
		||||
Caching
 | 
			
		||||
=======
 | 
			
		||||
 | 
			
		||||
Ocelot supports some very rudimentary caching at the moment provider by 
 | 
			
		||||
the `CacheManager <http://cachemanager.net/>`_ project. This is an amazing project
 | 
			
		||||
that is solving a lot of caching problems. I would reccomend using this package to 
 | 
			
		||||
cache with Ocelot. If you look at the example `here <https://github.com/TomPallister/Ocelot/blob/develop/test/Ocelot.ManualTest/Startup.cs>`_ you can see how the cache manager is setup and then passed into the Ocelot 
 | 
			
		||||
AddOcelotOutputCaching configuration method. You can use any settings supported by 
 | 
			
		||||
the CacheManager package and just pass them in.
 | 
			
		||||
 | 
			
		||||
Anyway Ocelot currently supports caching on the URL of the downstream service 
 | 
			
		||||
and setting a TTL in seconds to expire the cache. You can also clear the cache for a region
 | 
			
		||||
by calling Ocelot's administration API.
 | 
			
		||||
 | 
			
		||||
In order to use caching on a route in your ReRoute configuration add this setting.
 | 
			
		||||
 | 
			
		||||
.. code-block:: json
 | 
			
		||||
 | 
			
		||||
    "FileCacheOptions": { "TtlSeconds": 15, "Region": "somename" }
 | 
			
		||||
 | 
			
		||||
In this example ttl seconds is set to 15 which means the cache will expire after 15 seconds.
 | 
			
		||||
		Reference in New Issue
	
	Block a user