dotnet 7.0 API Gateway
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Go to file
Raman Maksimchuk d7754af609
Merge pull request #1809 from ThreeMammals/release/22.0
Sync 'develop' to 'release/22.0'
3 days ago
.circleci +semver: breaking | Release 21.0 2 weeks ago
.config +semver: breaking | Release 21.0 2 weeks ago
.github docker build works on windows 4 years ago
docker +semver: breaking | Release 21.0 2 weeks ago
docs Release 22.0 | +semver: breaking 5 days ago
images add ocelot logo to repo 2 years ago
postman Make Ocelot work with service fabric DNS and naming service for guest exe and stateless (#242) 6 years ago
samples #1787 Upgrade to .NET 8 (#1789) 2 weeks ago
src Revert #1172 feature (#1807) 5 days ago
test Revert #1172 feature (#1807) 5 days ago
.dockerignore Feat/net6.0 upgrade (#1558) 2 years ago
.editorconfig #1787 Upgrade to .NET 8 (#1789) 2 weeks ago
.gitattributes Remove Ocelot specific Middleware to make Ocelot more compatible with kestrel middleware and get ready for YARP 4 years ago
.gitignore .NET8 Release artifacts (#1792) 2 weeks ago
.readthedocs.yaml #1731 Read the Docs configuration file v2 (#1733) 2 months ago
Directory.Build.props Updated to netcoreapp3.1 4 years ago
GitVersion.yml hacked together load balancing reroutes in fileconfig (#211) 6 years ago .NET8 Release artifacts (#1792) 2 weeks ago
Ocelot.sln Merge 'release/net8' into 'release/net8-to-develop' 2 weeks ago .NET8 Release artifacts (#1792) 2 weeks ago Release 22.0 | +semver: breaking 5 days ago
build.cake Switch off the PublishToNuget task 4 days ago
codeanalysis.ruleset Release features #1499 #1663 (#1660) (#1693) 2 months ago

Ocelot Logo



Ocelot is a .NET API Gateway. This project is aimed at people using .NET running a microservices / service-oriented architecture that need a unified point of entry into their system. However it will work with anything that speaks HTTP(S) and run on any platform that ASP.NET Core supports.

In particular we want easy integration with IdentityServer reference and Bearer tokens. We have been unable to find this in our 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 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!


A quick list of Ocelot's capabilities, for more information see the Documentation.


Ocelot is designed to work with ASP.NET Core and it targets net6.0, net7.0 and net8.0 frameworks. 4

Install Ocelot package and its dependencies using NuGet Package Manager:

Install-Package Ocelot

Or via the .NET CLI:

dotnet add package Ocelot

All versions can be found on nuget.


  • Ocelot documentation — Read the Docs
    This includes lots of information and will be helpful if you want to understand the features Ocelot currently offers.
  • Ocelot RST Docs
    This includes source code of documentation as .rst files which are up to date for current development.

Coming up

You can see what we are working on in backlog.


We love to receive contributions from the community, so please keep them coming :octocat:
Pull requests, issues and commentary welcome!

Please complete the relevant template for issues and PRs. Sometimes it's worth getting in touch with us to discuss 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 :octocat:

Finally, we mark all existing issues as label: help wanted label: small effort label: medium effort label: large effort. 5
If you want to contribute for the first time, we suggest looking at a label: help wanted label: small effort label: good first issue :octocat:


  1. Ocelot doesnt directly support GraphQL. Developers can easily integrate the GraphQL for .NET library. ↩︎

  2. Ocelot does support Consul, Netflix Eureka, Service Fabric service discovery providers, and special modes like Dynamic Routing and Custom Providers. ↩︎

  3. Retry policies only via Polly library. ↩︎

  4. Starting with v21.0, the solution's code base supports Multitargeting as SDK-style projects. It should be easier for teams to move between (migrate to) .NET 6, 7 and 8 frameworks. Also, new features will be available for all .NET SDKs which we support via multitargeting. Find out more here: Target frameworks in SDK-style projects ↩︎

  5. See all labels of the repository. ↩︎