siliond/ocelot

.NET core API Gateway.

Ocelot

Ocelot is a .NET Api Gateway. This project is aimed at people using .NET running a micro services / service orientated architecture that need a unified point of entry into their system.

In particular I want easy integration with IdentityServer reference and bearer tokens.

We have been unable to find this in my current workplace without having to write our own Javascript middlewares to handle the IdentityServer reference tokens. We would rather use the IdentityServer code that already exists to do this.

Ocelot is a bunch of middlewares in a specific order.

Ocelot manipulates the HttpRequest object into a state specified by its configuration until it reaches a request builder middleware where it creates a HttpRequestMessage object which is used to make a request to a downstream service. The middleware that makes the request is the last thing in the Ocelot pipeline. It does not call the next middleware. The response from the downstream service is stored in a per request scoped repository and retrieved as the requests goes back up the Ocelot pipeline. There is a piece of middleware that maps the HttpResponseMessage onto the HttpResponse object and that is returned to the client. That is basically it with a bunch of other features.

How to install

Ocelot is designed to work with ASP.NET core only and is currently built to netcoreapp2.0 this documentation may prove helpful when working out if Ocelot would be suitable for you.

Install Ocelot and it's dependencies using NuGet.

Install-Package Ocelot

All versions can be found here

Documentation

Please click here for the Ocleot documentation. This includes lots of information and will be helpful if you want to understand the features Ocelot currently offers.

Coming up

You can see what we are working on here

Contributing

Pull requests, issues and commentary welcome! No special process just create a request and get in touch either via gitter or create an issue.

Things that are currently annoying me

• The base OcelotMiddleware lets you access things that are going to be null and doesnt check the response is OK. I think the fact you can even call stuff that isnt available is annoying. Let alone it be null.

Get more details at codescene.io.