Ocelot 24.0.1

Ocelot Logo

Release Status Development Status ReadTheDocs Coveralls License: MIT NuGet Downloads

About

Ocelot is a .NET API 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 that ASP.NET Core supports.

Ocelot consists of a series of ASP.NET Core middlewares arranged in a specific order.

Ocelot custom middlewares manipulate 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 request 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!

Features

A concise list of Ocelot's capabilities, for further details refer to Documentation

Install

Ocelot is designed to work with ASP.NET Core and it targets net8.0 LTS and net9.0 STS target framework monikers (TFMs). 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 are available on NuGet.

Documentation

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

Coming up

You can see what we are working on in the backlog.

Contributing

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

Please complete the relevant template for issues and pull requests. 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. 6 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

Notes


  1. Ocelot does not directly support GraphQL. Developers can easily integrate the GraphQL for .NET library.

  2. Ocelot supports the following service discovery providers: (1) Consul through the Ocelot.Provider.Consul extension package, (2) Kubernetes via the Ocelot.Provider.Kubernetes extension package, and (3) Netflix Eureka, which utilizes the Steeltoe.Discovery.Eureka package referenced within the Ocelot.Provider.Eureka extension package. Additionally, Ocelot supports (4) Azure Service Fabric for service discovery, along with special modes such as Dynamic Routing and Custom Providers.

  3. Retry policies only via Polly library referenced within the Ocelot.Provider.Polly extension package.

  4. Starting with version 21 and higher, the solution's code base supports Multitargeting as SDK-style projects. It should be easier for teams to migrate to the currently supported .NET 8 and 9 frameworks. Also, new features will be available for all .NET SDKs that we support via multitargeting. Find out more here: Target frameworks in SDK-style projects

  5. Ocelot Guru is an unofficial tool to get answers regarding Ocelot: please consider it an advanced search tool. Thus, we have an official Questions & Answers category in the Discussions space.

  6. See all labels for the repository, which are useful for searching and filtering.

Showing the top 20 packages that depend on Ocelot.

Packages Downloads
Ocelot.Provider.Consul
Provides Ocelot extensions to use Consul
25
Ocelot.Provider.Consul
Provides Ocelot extensions to use Consul
26
Ocelot.Provider.Consul
Provides Ocelot extensions to use Consul
27
Ocelot.Provider.Consul
Provides Ocelot extensions to use Consul
28
Ocelot.Provider.Consul
Provides Ocelot extensions to use Consul
29
Ocelot.Provider.Consul
Provides Ocelot extensions to use Consul
32
Ocelot.Provider.Polly
Provides Ocelot extensions to use Polly.NET
25
Ocelot.Provider.Polly
Provides Ocelot extensions to use Polly.NET
26
Ocelot.Provider.Polly
Provides Ocelot extensions to use Polly.NET
27

Upgrade to .NET 9 with supported TFMs (net8.0;net9.0)

Version Downloads Last updated
24.0.1 9 07/18/2025
24.0.0 16 04/25/2025
24.0.0-beta.3 6 09/16/2025
24.0.0-beta.2 3 10/16/2025
24.0.0-beta.1 9 06/19/2025
24.0.0-alpha.30 5 07/24/2025
23.5.0-beta.5 13 04/11/2025
23.5.0-beta.4 15 04/11/2025
23.5.0-beta.3 14 04/11/2025
23.5.0-beta.2 14 04/11/2025
23.5.0-beta.1 13 04/11/2025
23.4.3 21 01/29/2025
23.4.2 23 12/02/2024
23.4.1 21 12/12/2024
23.4.0 24 11/29/2024
23.3.6 26 11/17/2024
23.3.4 24 11/14/2024
23.3.3 23 12/12/2024
23.3.0 23 11/14/2024
23.2.2 25 05/26/2024
23.2.0 24 05/04/2024
23.1.0 27 05/06/2024
23.0.0 22 05/01/2024
22.0.1 23 12/02/2024
22.0.0 19 11/29/2024
21.0.0 20 05/05/2024
20.0.0 29 05/08/2024
19.0.4 21 11/24/2024
19.0.3 17 12/09/2024
19.0.2 24 05/05/2024
19.0.1 20 12/06/2024
19.0.0 22 12/09/2024
18.0.0 27 04/30/2024
17.0.1 18 12/06/2024
17.0.0 30 09/19/2022
16.0.2 23 05/10/2024
16.0.1 21 12/02/2024
16.0.0 21 12/02/2024
15.0.7 22 05/07/2024
15.0.1 27 05/04/2024
15.0.0 24 11/25/2024
14.1.3 27 05/01/2024
14.1.2 23 12/04/2024
14.1.1 28 05/08/2024
14.1.0 16 05/18/2025
14.0.12 21 05/30/2024
14.0.11 19 04/13/2025
14.0.9 20 03/12/2025
14.0.8 27 05/07/2024
14.0.5 28 05/08/2024
14.0.4 5 08/28/2025
14.0.2 27 05/01/2024
14.0.0 23 12/11/2024
13.9.0-alpha0115 19 12/03/2024
13.8.5 14 03/14/2025
13.8.2 27 05/03/2024
13.8.1 8 08/18/2025
13.8.0-alpha0018 17 05/05/2024
13.8.0-alpha0008 24 05/04/2024
13.8.0-alpha0006 26 05/08/2024
13.8.0-alpha0002 18 04/10/2025
13.7.0-alpha0011 25 05/04/2024
13.7.0-alpha0009 25 05/04/2024
13.7.0-alpha0008 25 05/02/2024
13.7.0-alpha0006 34 05/06/2024
13.7.0-alpha0003 8 08/28/2025
13.7.0-alpha0002 7 09/03/2025
13.6.0-alpha0014 32 05/02/2024
13.6.0-alpha0010 26 05/05/2024
13.6.0-alpha0008 27 05/15/2024
13.6.0-alpha0006 33 04/09/2024
13.6.0-alpha0001 7 08/29/2025
13.5.2 25 05/02/2024
13.5.0-alpha0056 24 05/01/2024
13.5.0-alpha0053 11 05/11/2025
13.4.1 5 08/30/2025
13.2.0-alpha0034 16 12/10/2024
13.2.0-alpha0033 24 05/03/2024
13.2.0-alpha0030 24 05/07/2024
13.2.0-alpha0026 22 05/04/2024
13.2.0-alpha0021 17 01/06/2025
13.2.0-alpha0020 25 05/05/2024
13.2.0-alpha0009 22 12/02/2024
13.2.0-alpha0003 21 11/29/2024
13.2.0-alpha0001 26 05/06/2024
13.1.0-alpha0003 15 04/08/2025
12.1.0-unstable0003 17 05/09/2025
12.1.0-unstable0001 20 12/08/2024
12.1.0-alpha0027 18 05/05/2024
12.1.0-alpha0024 25 05/05/2024
12.1.0-alpha0020 5 08/28/2025
12.1.0-alpha0013 14 05/21/2025
12.0.0-unstable0014 20 05/05/2024
11.1.0-unstable0007 26 05/06/2024
11.1.0-unstable0006 22 12/26/2024
11.1.0-unstable0001 17 03/13/2025
11.0.3 27 05/26/2024
11.0.2 25 11/03/2024
11.0.1 26 05/26/2024
11.0.0 18 12/04/2024
10.1.0-unstable0017 21 11/22/2024
10.1.0-unstable0016 18 11/05/2024
10.1.0-unstable0015 7 08/28/2025
10.1.0-unstable0013 22 12/03/2024
10.1.0-unstable0011 7 08/10/2025
10.1.0-unstable0009 13 04/18/2025
10.1.0-unstable0008 4 08/26/2025
10.1.0-unstable0007 25 05/03/2024
10.1.0-unstable0006 13 04/16/2025
10.1.0-unstable0005 23 05/29/2024
10.1.0-unstable0003 28 05/02/2024
10.1.0-unstable0001 19 02/27/2025
10.0.3 20 05/02/2024
10.0.2 22 05/05/2024
10.0.1 18 04/09/2025
10.0.0 24 05/24/2024
9.1.0-unstable0001 11 06/02/2025
9.0.0 20 01/06/2025
9.0.0-unstable0041 24 05/06/2024
8.1.0-unstable0031 23 05/01/2024
8.1.0-unstable0030 26 05/07/2024
8.1.0-unstable0029 25 05/01/2024
8.1.0-unstable0028 26 05/01/2024
8.1.0-unstable0027 23 05/06/2024
8.1.0-unstable0023 19 05/08/2024
8.1.0-unstable0022 30 04/09/2024
8.1.0-unstable0021 22 05/01/2024
8.1.0-unstable0020 27 05/10/2024
8.1.0-unstable0014 24 05/01/2024
8.1.0-unstable0010 24 11/12/2024
8.1.0-unstable0009 22 05/04/2024
8.1.0-unstable0005 20 05/14/2024
8.1.0-unstable0002 14 05/07/2025
8.1.0-unstable0001 25 05/02/2024
8.0.8 21 02/15/2025
8.0.6 23 01/06/2025
8.0.4 20 05/25/2024
8.0.3 22 03/01/2025
8.0.2 32 05/06/2024
8.0.0 22 05/04/2024
8.0.0-unstable0044 20 12/06/2024
7.1.0-unstable0042 24 11/30/2024
7.1.0-unstable0041 26 05/15/2024
7.1.0-unstable0039 6 08/23/2025
7.1.0-unstable0037 29 05/01/2024
7.1.0-unstable0036 17 03/12/2025
7.1.0-unstable0035 24 05/01/2024
7.1.0-unstable0029 23 05/03/2024
7.1.0-unstable0026 27 04/10/2024
7.1.0-unstable0025 24 05/07/2024
7.1.0-unstable0023 24 05/06/2024
7.1.0-unstable0020 27 05/05/2024
7.1.0-unstable0019 25 05/02/2024
7.1.0-unstable0017 18 05/26/2024
7.1.0-unstable0012 24 05/06/2024
7.1.0-unstable0009 20 05/04/2024
7.1.0-unstable0007 20 03/13/2025
7.1.0-unstable0006 16 05/03/2025
7.1.0-unstable0005 21 05/23/2024
7.0.9 9 07/15/2025
7.0.8 23 01/16/2025
7.0.7 19 02/02/2025
7.0.6 21 05/10/2025
7.0.4 24 05/07/2024
7.0.0 22 01/15/2025
6.0.0 19 02/26/2025
6.0.0-unstable0064 27 05/06/2024
5.6.0-unstable0032 23 12/09/2024
5.6.0-unstable0031 18 12/04/2024
5.6.0-unstable0030 22 04/24/2025
5.6.0-unstable0029 23 05/06/2024
5.6.0-unstable0027 26 04/24/2024
5.6.0-unstable0024 23 05/04/2024
5.6.0-unstable0020 17 02/20/2025
5.6.0-unstable0006 26 05/07/2024
5.6.0-unstable0005 21 01/01/2025
5.6.0-unstable0004 7 08/22/2025
5.6.0-unstable0001 17 02/21/2025
5.5.7 21 03/18/2025
5.5.3 21 01/24/2025
5.5.2 24 05/07/2024
5.5.1 24 04/09/2024
5.5.0 14 05/27/2025
5.3.0 16 05/12/2025
5.3.0-unstable0004 22 12/06/2024
5.3.0-unstable0002 21 05/06/2024
5.2.0 25 05/01/2024
5.2.0-unstable0001 21 05/08/2024
5.1.0 23 05/10/2024
5.1.0-unstable0008 24 05/01/2024
5.1.0-unstable0006 21 05/02/2024
5.1.0-unstable0005 28 05/25/2024
5.0.1 22 05/06/2024
5.0.0 25 12/03/2024
4.1.0-unstable0001 24 05/07/2024
4.0.0 25 01/03/2025
3.2.0-unstable0044 22 05/01/2024
3.2.0-unstable0040 9 07/28/2025
3.2.0-unstable0033 25 05/04/2024
3.2.0-unstable0016 23 01/06/2025
3.2.0-unstable0015 22 01/26/2025
3.2.0-unstable0005 20 05/07/2024
3.1.6 16 04/04/2025
3.1.5 29 05/07/2024
3.1.0-unstable0010 28 05/02/2024
3.1.0-unstable0005 22 05/01/2024
3.0.3 31 05/01/2024
3.0.2 30 04/24/2024
3.0.0 27 05/06/2024
3.0.0-unstable0059 22 12/27/2024
2.1.0-unstable0057 7 08/12/2025
2.1.0-unstable0055 20 12/28/2024
2.1.0-unstable0051 25 05/07/2024
2.1.0-unstable0049 23 05/06/2024
2.1.0-unstable0048 23 03/15/2025
2.1.0-unstable0043 19 05/04/2024
2.1.0-unstable0037 26 05/01/2024
2.1.0-unstable0036 18 02/25/2025
2.0.11 26 05/02/2024
2.0.10 24 05/03/2024
2.0.8 19 12/31/2024
2.0.6 26 05/01/2024
2.0.5 7 08/26/2025
2.0.4 25 04/24/2024
2.0.3 29 05/04/2024
2.0.2 29 05/02/2024
2.0.1 25 05/01/2024
2.0.0 23 11/28/2024
1.5.0-unstable0158 22 05/06/2024
1.5.0-unstable0154 22 05/01/2024
1.5.0-unstable0149 15 02/24/2025
1.5.0-unstable0147 11 03/21/2025
1.5.0-unstable0131 21 10/31/2024
1.5.0-unstable0115 24 05/02/2024
1.5.0-unstable0107 22 12/28/2024
1.5.0-unstable0103 8 08/13/2025
1.5.0-unstable0071 24 05/08/2024
1.5.0-unstable0053 22 05/06/2024
1.5.0-unstable0043 22 04/30/2024
1.5.0-unstable0027 17 04/09/2025
1.4.20 16 05/10/2025
1.4.11 20 05/02/2024
1.4.10 23 05/02/2024
1.4.9 21 05/06/2024
1.4.8 20 01/17/2025
1.4.7 29 05/05/2024
1.4.6 21 01/18/2025
1.4.5 22 12/03/2024
1.4.4 16 04/07/2025
1.4.1 22 05/07/2024
1.4.0-unstable0105 14 05/08/2025
1.4.0-unstable0089 27 05/06/2024
1.4.0-unstable0058 25 04/30/2024
1.4.0-unstable0055 24 05/07/2024
1.4.0-unstable0026 22 05/04/2024
1.4.0-set-up-admin-api0001 25 05/21/2024
1.4.0-qos-documentatio0001 9 06/04/2025
1.4.0-pullrequest0047 5 09/10/2025
1.4.0-beta0001 8 08/08/2025
1.3.3-pullrequest0054 24 05/04/2024
1.3.2 25 05/06/2024
1.3.1 25 05/02/2024
1.3.0-unstable0002 25 05/05/2024
1.2.0-unstable0033 20 05/06/2024
1.1.0 24 11/14/2024
1.0.123 23 05/06/2024
1.0.122 20 02/21/2025
1.0.117 23 11/21/2024
1.0.114-rc1 26 05/04/2024
1.0.112-rc1 28 05/01/2024
1.0.110-rc1 16 02/16/2025
1.0.108-rc1 22 01/01/2025
1.0.107-rc1 26 05/06/2024
1.0.106-rc1 12 04/29/2025
1.0.102-rc1 22 12/28/2024
1.0.101-rc1 28 05/05/2024
1.0.100-rc1 26 05/05/2024
1.0.98-rc1 22 12/11/2024
1.0.97-rc1 24 05/02/2024
1.0.95-rc1 26 12/18/2024
1.0.90-rc1 28 05/07/2024
1.0.87-rc1 24 11/28/2024
1.0.84-rc1 27 05/04/2024
1.0.83-rc1 28 05/06/2024
1.0.81-rc1 20 05/05/2024
1.0.79-rc1 18 04/09/2025
1.0.78-rc1 24 05/01/2024
1.0.68-rc1 24 05/06/2024
1.0.66-rc2 23 05/06/2024
1.0.66-rc1 24 05/06/2024
0.0.13-rc1 23 05/04/2024
0.0.12-rc1 20 12/01/2024
0.0.0-dev 17 04/12/2025