httpcache

README

Krakend HTTP Cache

A cached http client for the KrakenD framework

Using it

This package exposes two simple factories capable to create a instances of the proxy.HTTPClientFactory and the proxy.BackendFactory interfaces, respectively, embedding an in-memory-cached http client using the package github.com/gregjones/httpcache. The client will cache the responses honoring the defined Cache HTTP header.

import 	(
	"context"
	"net/http"
	"github.com/davron112/lura/v2/config"
	"github.com/davron112/lura/v2/proxy"
	"github.com/davron112/lura/v2/transport/http/client"
	"github.com/davron112/krakend-httpcache/v2"
)

requestExecutorFactory := func(cfg *config.Backend) proxy.HTTPRequestExecutor {
	clientFactory := httpcache.NewHTTPClient(cfg, client.NewHTTPClient)
	return func(ctx context.Context, req *http.Request) (*http.Response, error) {
		return clientFactory(ctx).Do(req.WithContext(ctx))
	}
}

You can create your own proxy.HTTPRequestExecutor and inject it into your BackendFactory

Documentation

Overview

Package httpcache introduces an in-memory-cached http client into the KrakenD stack

Index

• Constants
• func NewHTTPClient(cfg *config.Backend, nextF client.HTTPClientFactory) client.HTTPClientFactory
• type Cache

Constants

const Namespace = "github.com/davron112/krakend-httpcache"

Namespace is the key to use to store and access the custom config data

Functions

func NewHTTPClient

func NewHTTPClient(cfg *config.Backend, nextF client.HTTPClientFactory) client.HTTPClientFactory

NewHTTPClient creates a HTTPClientFactory using an in-memory-cached http client

Types

type Cache

type Cache interface {
	// Get returns the []byte representation of a cached response and a bool
	// set to true if the value isn't empty
	Get(key string) (responseBytes []byte, ok bool)
	// Set stores the []byte representation of a response against a key
	Set(key string, responseBytes []byte)
	// Delete removes the value associated with the key
	Delete(key string)
}