News Improving The Developer Experience of Your APIs

Community Documentation

Recent changes

You are viewing a previous version of KrakenD Community Edition (v2.0) , go to the latest version

Introduction to custom plugins and middlewares

Document updated on Nov 25, 2021

Plugins are soft-linked libraries, thus a separated .so file, that when running in conjunction with KrakenD can participate in the processing. When we talk about plugins we refer to Go plugins.

Middlewares are the different repositories and components that when compiled all together they form the final KrakenD binary. If you want to change its behaviour you must recompile KrakenD.

Do I need a plugin?
In most of the cases, you don’t need a custom plugin. The combination of different functionalities offered by the middlewares might help you solve a myriad of scenarios, with special mention to CEL, Martian, or even Lua scripting. If you’d like to introduce custom business logic, a plugin does not limit what you can do. Also, if you need a lot of performance, a Go plugin is much faster than a Lua script (generally speaking at least x10).

Unlike KrakenD middlewares, plugins are an independent binary of your own and are not part of KrakenD itself. Plugins allow you to “drag and drop” custom functionality that interacts with KrakenD while still using the official binaries with no need to fork the code.

Let’s get you started building custom code!

Types of plugins

There are four different types of plugins you can write:

  1. HTTP server plugins (or handler plugins): They belong to the router layer and let you modify the request before KrakenD starts processing it, or modify the final response. You can have several plugins at once.
  2. HTTP client plugins (or proxy client plugins): They belong to the proxy layer and let you change how KrakenD interacts (as a client) with your backend services. You can have one plugin per backend.
  3. Response Modifier plugins: They are strictly modifiers and let you change the responses received from your backends.
  4. Request Modififer plugins: They are strictly modifiers and let you change the requests sent to your backends.

All types of plugins are marked with colored dots in the following diagram.

Krakend Plugins

In a nutshell, the sequence of a request-response depicted in the graph of the plugins above is as follows:

  1. The end-user/server sends an HTTP request to KrakenD that is processed by the router pipe. One or more HTTP server (a.k.a http handler) plugins can be injected in this stage.
  2. The router pipe transforms the HTTP request into one or several proxy requests -HTTP or not- through a handler function. The request modifier plugin can intercept this stage and make modifications.
  3. The proxy pipe fetches the data for all the requests through the selected transport layer. The HTTP client plugin modifies any interaction with the backend.
  4. The proxy pipe manipulates, aggregates, applies components… and returns the context to the router pipe. The response modifier plugin) can manipulate the data per backend or when everything is aggregated.
  5. The router pipe finally converts back the proxy response into an HTTP response.

When you have chosen the type of plugin that fits best your scenario, it’s time to write your plugin.

Custom middleware

The recommended way to customize KrakenD is through plugins. But as all open-source code, you can modify KrakenD and its middlewares and do your own version. When writing your custom code, fork the KrakenD-CE repository, and read “Understanding the big picture” to identify the important packages.

The krakend-ce repository is the one assembling all the middlewares and manages the dependencies (including Lura). It lets you effortlessly include your company customizations, as the project itself is mostly a wrapper for all components. Be aware that when you fork KrakenD you will need to maintain your custom version, which differs from the official binaries.

There are many examples of different modules (included in KrakenD-CE and not) on our contributions list. If you create new middlewares, feel free to open a pull request and let us know.

A relaxed start to build a custom component for KrakenD is our article “Website development as a sysadmin” where you can find custom code to add automatic API authentication against a backend. This functionality can be achieved without forking the code, but still, it is an illustrative example.


Unresolved issues?

The documentation is only a piece of the help you can get! Whether you are looking for Open Source or Enterprise support, see more support channels that can help you.