Skip to content

Latest commit

 

History

History
37 lines (27 loc) · 1.64 KB

README.md

File metadata and controls

37 lines (27 loc) · 1.64 KB

httpcache

GoDoc Go Report Card

As simple as it gets HTTP cache. It is heavily inspired by gregjones/httpcache, but it ignores the response headers. If you need a cache that respects these, please take a look at gregjones/httpcache and lox/httpcache.

Usage

cache := memcache.New()
httpClient := httpcache.New(cache).Client()

Per default every response is cached, even POST with a status code outside the range [200-300[. You can specify if a response should get saved by providing a function using the Verify option.

cache := memcache.New()
client := httpcache.New(cache,
  httpcache.WithVerifier(func(req *http.Request, res *http.Response) bool {
    return res.StatusCode >= 200 && res.StatusCode < 300
  }),
).Client()

A common example, only cache GET requests that don't fail, could look like the following.

client := httpcache.New(memcache.New(),
  httpcache.WithVerifier(httpcache.StatusInTwoHundreds),
  httpcache.WithVerifier(httpcache.RequestMethod(http.MethodGet)),
).Client()

Cache

Currently there are two cache methods: in memory and on disk using diskv. Caches have to implement the Cache interface, which is basically a key-value-store with two functions Get and Set.