Repository files navigation

Ocelot is a .NETAPI gateway.This project is aimed at people using .NET running a microservices (service-oriented) architecture that needs a unified point of entry into their system.However, it will work with anything that speaks HTTP(S) and runs on any platform thatASP.NET Core supports.

Ocelot consists of a series of ASP.NET Coremiddlewares arranged in a specific order.Ocelotcustom middlewares manipulate theHttpRequest object into a state specified by its configuration until it reaches a request builder middleware, where it creates aHttpRequestMessage 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 retrieved as the request goes back up the Ocelot pipeline.There is a piece of middleware that maps theHttpResponseMessage onto theHttpResponse object, and that is returned to the client.That is basically it, with a bunch of other features!

Ocelot is designed to work withASP.NET Core and it targetsnet8.0LTS andnet9.0STS target framework monikers (TFMs).¹

InstallOcelot package and its dependencies using NuGet package manager:

Install-Package Ocelot

Or via the .NET CLI:

dotnet add package Ocelot

All versions are availableon NuGet.

• RST-sources:This includes the source code for the documentation (in reStructuredText format, .rst files), which is up to date for the currentdevelopment.And the rendered HTML documentation is availablehere.
• Read the Docs:This official website, in HTML format, contains a wealth of information and will be helpful if you want to understand thefeatures that Ocelot currently offers.The rendered HTML documentation, which is currently indevelopment, is availablehere.
• Ask Ocelot Guru:It is an AI focused on Ocelot, designed to answer your questions.²

The primary features—Configuration andRouting—are always utilized by users, even in a minimal app setup, without customizations or extra configurations.Ocelot's capabilities are categorized into three main groups of features:solid,hybrid, andfeature-family groups, which are explained below.

• Solid features are unique to Ocelot. They do not contain subfeatures and are not related to other features.
• Hybrid features, on the other hand, have multiple relationships with other features and can be part of other features.
• Feature families are large groups that consist of multiple subfeatures.

Feature groups are explained in the table below →

Ocelot customizations can be configured usingMetadata, developed withDelegating Handlers, and in advanced scenarios, they can be developed and then configured withMiddleware Injection.For further details, refer to theDocumentation.

You can see what we are working on in thebacklog.We love to receive contributions from the community, so please keep them coming.Pull requests, issues, and commentary welcome!

Please complete the relevanttemplate forissues andpull requests.Sometimes it's worth getting in touch with us todiscuss changes before doing any work in case this is something we are already doing or it might not make sense.We can also give advice on the easiest way to do things

Finally, we mark all existing issues as.⁷If you want to contribute for the first time, we suggest looking at a