kong-plugin-corax's Introduction

Corax

redis response caching for the masses
                                                 ,::::.._
                                               ,':::::::::.
                                           _,-'`:::,::(o)::`-,.._
                                        _.', ', `:::::::::;'-..__`.
                                   _.-'' ' ,' ,' ,\:::,'::-`'''
                               _.-'' , ' , ,'  ' ,' `:::/
                         _..-'' , ' , ' ,' , ,' ',' '/::
                 _...:::'`-..'_, ' , ,'  , ' ,'' , ,'::|
              _`.:::::,':::::,'::`-:..'_',_'_,'..-'::,'|
      _..-:::'::,':::::::,':::,':,'::,':::,'::::::,':::;
        `':,'::::::,:,':::::::::::::::::':::,'::_:::,'/
        __..:'::,':::::::--''' `-:,':,':::'::-' ,':::/
   _.::::::,:::.-''-`-`..'_,'. ,',  , ' , ,'  ', `','
 ,::SSt:''''`                 \:. . ,' '  ,',' '_,'
                               ``::._,'_'_,',.-'
                                   \\ \\
                                    \\_\\
                                     \\`-`.-'_
                                  .`-.\\__`. ``
                                     ``-.-._
                                         `

Corax is a plugin for Kong that adds upstream response caching using Redis as an storage backend.

Responses to an upstream request will be cached by Corax when they match based on request method, response codes and content type. Once cached, requests matching a cached object will be served from cache instead of going upstream, until the cached object expires.

Configuration

field	default	description
`response_code`	200, 201, 301, 401
`request_method`	`GET, POST`
`content_type`	`application/json`, `text/plain`
`vary_query_params`		query string parameters included on key generation. Uses all if empty
`vary_headers`		request headers included on key generation. Uses none if empty
`cache_ttl`	300	TTL in seconds
`redis_host`	`localhost`
`redis_port`	6379
`redis_password`
`redis_database`	0