News KrakenD 2.1.1 Enterprise released - Now with ARM64 support

Documentation

Recent changes

Creating API endpoints

KrakenD endpoints are the most critical configuration part of KrakenD, as they are what your end users consume. Adding endpoint objects creates the API contract your users will consume.

Configuration overview
If you are still unfamiliar with KrakenD’s configuration structure, take a moment to read Understanding the configuration file.

The endpoints array contains the API definition you are publishing. It is a collection of endpoint objects, and you have to place it at the root of your configuration file.

The endpoint object

To create an endpoint, you only need to add an endpoint object under the endpoints collection. An endpoint object should contain at least the endpoint name and a backend section (to where it connects to). The defaults are taken if no further information is declared (e.g.: method will be a GET, and output_encoding as json).

An endpoints section might look like this:

{
  "endpoints": [
    {
      "endpoint": "/v1/users/{user}",
      "method": "GET",
      "backend": [
        {
          "url_pattern": "/users/summary/{user}",
          "method": "GET",
          "host": [
            "https://api.mybackend.com"
          ]
        }
      ]
    }
  ]
}

The previous example exposes to the clients a GET /v1/users/{user} endpoint and takes the data from your existing backend GET https://api.mybackend.com/users/summary/{user}.

Inside this object, you can add manipulation options and transform the response before it returns to the end user.

Endpoint configuration

The configuration attributes of endppoints are:

backend *

array
List of all the backend objects queried for this endpoint
cache_ttl

Sets or overrides the cache headers to inform for how long the client or CDN can cache the request to this endpoint. Related: caching backend responses.
Valid duration units are: ns (nanosec.), us or µs (microsec.), ms (millisec.), s (sec.), m (minutes), h (hours).
concurrent_calls

integer
The concurrent requests are an excellent technique to improve the response times and decrease error rates by requesting in parallel the same information multiple times. Yes, you make the same request to several backends instead of asking to just one. When the first backend returns the information, the remaining requests are canceled.
Defaults to 1
endpoint *

string
The exact string resource URL you want to expose. You can use {placeholders} to use variables when needed. URLs do not support colons : in their definition. Endpoints should start with slash /. Example: /foo/{var}. If {vars} are placed in the middle words, like in /var{iable} you must set in the root level disable_rest strict checking.
extra_config

object
Configuration entries for additional components that are executed within this endpoint, during the request, response or merge operations.
input_headers

array
Defines the list of all headers allowed to reach the backend when passed. By default, KrakenD won’t pass any header from the client to the backend. See headers forwarding
Defaults to []
input_query_strings

array
Defines the exact list of quey strings parameters that are allowed to reach the backend. By default, KrakenD won’t pass any query string to the backend.
Defaults to []
method

string
The method supported by this endpoint. Create multiple endpoint entries if you need different methods.
Possible values are: GET , POST , PUT , PATCH , DELETE
Defaults to "GET"
output_encoding

string
The gateway can work with several content types, even allowing your clients to choose how to consume the content. See the supported encodings
Possible values are: json , json-collection , fast-json , xml , negotiate , string , no-op
Defaults to "json"
timeout

string
The duration you write in the timeout represents the whole duration of the pipe, so it counts the time all your backends take to respond and the processing of all the components involved in the endpoint (the request, fetching data, manipulation, etc.). Usually specified in seconds (s) or milliseconds (ms. e.g.: 2000ms or 2s). If you don’t set any timeout, the timeout is taken from the entry in the service level, or to the system’s default
Valid duration units are: ns (nanosec.), us or µs (microsec.), ms (millisec.), s (sec.), m (minutes), h (hours).
Defaults to "2s"

* indicates a required field. Parameters in alphabetical order.

Endpoints with multiple nesting levels

You might have envisioned KrakenD as a proxy and expected its endpoint declaration to work as a prefix and listen to any path with an undetermined number of nesting levels. But KrakenD does not work like this by default. Instead, it expects you to declare every possible URL structure.

For instance, you declared an "endpoint": "/user/{id}" and you expected to resolve URLs like /user/john/profile/preferences, but you are getting a 404 instead. There are two solutions to this problem:

  1. You can declare all possible endpoints: /user/{id}, /user/{id}/{level2}, /user/{id}/{level2}/{level3}, etc.
  2. You use a Wildcard Enterprise

Endpoints listening to multiple methods

The method attribute defines the HTTP verb you can use with the endpoint. If you need to support multiple methods (e.g., GET, POST, DELETE) in the same endpoint, you will need to declare one endpoint object for each method. So if you want the same endpoint to listen to GET and POST requests, you need the following configuration:

{
  "endpoints": [
    {
      "endpoint": "/v1/users/{user}",
      "method": "GET",
      "backend": [
        {
          "url_pattern": "/users/summary/{user}",
          "method": "GET",
          "host": [
            "https://api.mybackend.com"
          ]
        }
      ]
    },
    {
      "endpoint": "/v1/users/{user}",
      "method": "POST",
      "backend": [
        {
          "url_pattern": "/users/summary/{user}",
          "method": "POST",
          "host": [
            "https://api.mybackend.com"
          ]
        }
      ]
    }

  ]
}
Notice that the method is declared both in the endpoint and in the backend (as they could be different).

Endpoint variables

As you can see in the examples above, endpoints can define variables in their endpoint definition. To do so, encapsulate the variable name with curly braces, like {var}.

{
  "endpoint": "/user/{id}"
}

The previous endpoint will accept requests like /user/123 or /user/A-B-C. But it won’t take a request like /user/1/2, as there is an extra slash than the definition, and KrakenD considers this to be a different endpoint.

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.

We use cookies to understand how you use our site and to improve your overall experience. By continuing to use our site, you accept our Privacy Policy. More information