Snapshot of ThreeMammals/Ocelot: 8.7k★, C#, Backend. .NET API Gateway
Snapshot summary built from the project's own GitHub metadata — there's no written TopGit review yet. The page will update automatically when a full review is published.
WHY NO REVIEW YET
TopGit writes full reviews for the most-starred, most-requested repositories. This page is a snapshot until then — see the READ ME tab for the original README in full.
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!
Install
Ocelot is designed to work with ASP.NET Core and it targets net9.0 STS and net8.0, net10.0 LTS target framework monikers (TFMs). 1
Install Ocelot package and its dependencies using 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. 2
Features
The primary features—Configuration and Routing—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, and feature-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.
Group
Features
Primary
Configuration, Routing
Solid
Caching, Delegating Handlers, Quality of Service3, Rate Limiting
Configuration, Routing, Logging, Transformations, Service Discovery5
Feature groups are explained in the table below
Feature
Relationships and Notes
Administration
Administration heavily depends on Authentication, and Administration API methods are part of Authentication, Caching, and Configuration
Aggregation4
Aggregation relies on Routing
Authentication
Authentication followed by Authorization
Configuration
Configuration depends on Dependency Injection, including GET/POST operations via the Administration REST API, a specialized Websockets scheme/protocol, advanced Middleware Injection, and Metadata-based extensions
Routing
Routing offers specialized Websockets and Dynamic Routing modes but does not support GraphQL6
Load Balancer
Load Balancer is a critical dependency for Service Discovery
Logging
Logging includes Error Handling and Tracing
Service Discovery5
Service Discovery with the following discovery providers: Consul, Kubernetes, Eureka, and Service Fabric
Transformations
They provide transformations for Claims, Headers, and Method
Ocelot customizations can be configured using Metadata, developed with Delegating Handlers, and in advanced scenarios, they can be developed and then configured with Middleware Injection.
For further details, refer to the Documentation.
:satellite: Release Radar
Stay updated with the latest releases of Ocelot and its extension packages from the ThreeMammals organization. This section provides a snapshot of release status across the entire Ocelot ecosystem.
Project
Latest Release
Pre-Release (beta)
Release Date
View the complete Release Radar for comprehensive release information, detailed metrics, CI/CD status, code quality badges, and more about each package.
:file_folder: Repository Structure
Welcome to Ocelot's minimalist folder organization! Our repository follows a clean, flat structure that makes it easy to navigate and contribute. Here's where everything lives:
Start with src/DependencyInjection/ to understand the startup flow
Read docs/ for architecture and feature documentation
Want to run tests?
Unit tests: dotnet test unit/Ocelot.UnitTests.csproj --verbosity quiet
Acceptance tests: dotnet test acceptance/Ocelot.Acceptance.csproj
Need to benchmark?
cd benchmark && dotnet run -c Release
Contributing?
Place code in appropriate folder (usually src/FeatureName/)
Add tests in parallel structure under unit/ or acceptance/
Submit a pull request! :tada:
Contributing
You can see what we are working on in the backlog.
We love to receive contributions from the community, so please keep them coming.
Pull requests, issues, and commentary welcome!
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
Finally, we mark all existing issues as .7
If you want to contribute for the first time, we suggest looking at a
Notes
Footnotes
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, 9, 10 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 ↩
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. ↩
Retry policies only via Polly library referenced within the Ocelot.QualityOfService.Polly extension package, a former Ocelot.Provider.Polly package. ↩
Previously, the Aggregation feature was called Request Aggregation in versions 23.4.3 and earlier. Internally, within the Ocelot team, this feature is referred to as Multiplexer. ↩ ↩2
Ocelot supports the following service discovery providers: (1) Consul through the Ocelot.Discovery.Consul extension package, (2) Kubernetes via the Ocelot.Discovery.KubeClient extension package, and (3) Netflix Eureka via the Ocelot.Discovery.Eureka extension package. Additionally, Ocelot supports (4) Azure Service Fabric service discovery (frozen dev), along with special Dynamic Routing mode. ↩ ↩2
Ocelot does not directly support GraphQL. Developers can easily integrate the GraphQL for .NET library. ↩
See all labels for the repository, which are useful for searching and filtering. ↩
The most recent commit recorded on ThreeMammals/Ocelot was 5 days ago, based on the GitHub push timestamp. The repository has 1.7k forks — one of the better signals of community interest.
How many stars does ThreeMammals/Ocelot have?
ThreeMammals/Ocelot has 8.7k GitHub stars — refresh the page for the live number, or check github.com/ThreeMammals/Ocelot. TopGit mirrors GitHub's count but does not claim minute-by-minute accuracy.
What else is in the Backend space?
ThreeMammals/Ocelot is tracked by TopGit under the Backend category, alongside 7 GitHub-tagged topics. Trending and Topics pages list peer repositories of comparable stars and language.
What language is ThreeMammals/Ocelot written in?
ThreeMammals/Ocelot is written primarily in C#. GitHub's language field is based on the largest share of bytes in the default branch.
What topics is ThreeMammals/Ocelot associated with?
GitHub's repository topics for ThreeMammals/Ocelot: "api-gateway", "aspnetcore", "dotnet", "gateway", "microservices", "ocelot", "reverse-proxy". TopGit's editorial category is Backend.
Where do I read more about ThreeMammals/Ocelot?
This TopGit page is a snapshot — the READ ME tab shows the project's own README content (links stripped, images preserved). The GitHub repository at github.com/ThreeMammals/Ocelot is the definitive source.
Why is ThreeMammals/Ocelot categorized under Backend?
TopGit places ThreeMammals/Ocelot in the Backend category based on its GitHub topics and description (tagged: "api-gateway", "aspnetcore", "dotnet"). Categories are assigned from real repository metadata, not editorial guesswork.
Read full README in the tab above.
Curious whether Ocelot is right for you?
Let ChatGPT, Claude, or Perplexity look into it — click below and see what AI actually says about Ocelot.