Skip to content

Latest commit

 

History

History
179 lines (121 loc) · 6.36 KB

headerstransformation.rst

File metadata and controls

179 lines (121 loc) · 6.36 KB

Headers Transformation

Ocelot allows the user to transform headers pre and post downstream request. At the moment Ocelot only supports find and replace. This feature was requested in issue 190 and the team decided that it was going to be useful in various ways.

Add to Request

This feature was requested in issue 313.

If you want to add a header to your upstream request please add the following to a Route in your ocelot.json:

"UpstreamHeaderTransform": {
  "Uncle": "Bob"
}

In the example above a header with the key Uncle and value Bob would be send to to the upstream service.

Placeholders are supported too (see below).

Add to Response

This feature was requested in issue 280.

If you want to add a header to your downstream response, please add the following to a Route in ocelot.json:

"DownstreamHeaderTransform": {
  "Uncle": "Bob"
}

In the example above a header with the key Uncle and value Bob would be returned by Ocelot when requesting the specific Route.

If you want to return the Butterfly APM trace id then do something like the following:

"DownstreamHeaderTransform": {
  "AnyKey": "{TraceId}"
}

Find and Replace

In order to transform a header first we specify the header key and then the type of transform we want e.g.

"Test": "http://www.bbc.co.uk/, http://ocelot.com/"

The key is Test and the value is http://www.bbc.co.uk/, http://ocelot.com/. The value is saying: replace http://www.bbc.co.uk/ with http://ocelot.com/. The syntax is {find}, {replace}. Hopefully pretty simple. There are examples below that explain more.

Pre Downstream Request

Add the following to a Route in ocelot.json in order to replace http://www.bbc.co.uk/ with http://ocelot.com/. This header will be changed before the request downstream and will be sent to the downstream server.

"UpstreamHeaderTransform": {
  "Test": "http://www.bbc.co.uk/, http://ocelot.com/"
}

Post Downstream Request

Add the following to a Route in ocelot.json in order to replace http://www.bbc.co.uk/ with http://ocelot.com/. This transformation will take place after Ocelot has received the response from the downstream service.

"DownstreamHeaderTransform": {
  "Test": "http://www.bbc.co.uk/, http://ocelot.com/"
}

Placeholders

Ocelot allows placeholders that can be used in header transformation.

  • {BaseUrl} - This will use Ocelot base URL e.g. http://localhost:5000 as its value.
  • {DownstreamBaseUrl} - This will use the downstream services base URL e.g. http://localhost:5000 as its value. This only works for DownstreamHeaderTransform at the moment.
  • {RemoteIpAddress} - This will find the clients IP address using IHttpContextAccessor.HttpContext.Connection.RemoteIpAddress.ToString(), so you will get back some IP. See more in the GetRemoteIpAddress method.
  • {TraceId} - This will use the Butterfly APM Trace Id. This only works for DownstreamHeaderTransform at the moment.
  • {UpstreamHost} - This will look for the incoming Host header.

For now, we believe these placeholders are sufficient for basic user scenarios. But if you need more placeholders, you can head to the future.

Handling 302 Redirects

Ocelot will by default automatically follow redirects, however if you want to return the location header to the client, you might want to change the location to be Ocelot not the downstream service. Ocelot allows this with the following configuration:

"DownstreamHeaderTransform": {
  "Location": "http://www.bbc.co.uk/, http://ocelot.com/"
},
"HttpHandlerOptions": {
  "AllowAutoRedirect": false,
}

Or, you could use the BaseUrl placeholder.

"DownstreamHeaderTransform": {
  "Location": "http://localhost:6773, {BaseUrl}"
},
"HttpHandlerOptions": {
  "AllowAutoRedirect": false,
}

Finally, if you are using a load balancer with Ocelot, you will get multiple downstream base URLs so the above would not work. In this case you can do the following:

"DownstreamHeaderTransform": {
  "Location": "{DownstreamBaseUrl}, {BaseUrl}"
},
"HttpHandlerOptions": {
  "AllowAutoRedirect": false,
}

X-Forwarded-For

An example of using {RemoteIpAddress} placeholder:

"UpstreamHeaderTransform": {
  "X-Forwarded-For": "{RemoteIpAddress}"
}

Future

Ideally this feature would be able to support the fact that a header can have multiple values. At the moment it just assumes one. It would also be nice if it could multi find and replace e.g.

"DownstreamHeaderTransform": {
  "Location": "[{one,one},{two,two}]"
},
"HttpHandlerOptions": {
  "AllowAutoRedirect": false,
}

If anyone wants to have a go at this please, help yourself!

Global Headers Transformation

We have pending open PR 1659 for the 1658 issue. Current 20.0 version provides Route-level Headers Transformation feature, but we hope global transformations will be included in the next upcoming release.

Any ideas and proposals can be shared in the Discussions space of the repository! octocat