Skip to content
.NET core API Gateway
Branch: develop
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Fix incorrect command rendered (#949) Jul 1, 2019
postman Make Ocelot work with service fabric DNS and naming service for guest… Mar 3, 2018
samples Upgrade Projects (#900) May 24, 2019
src allow to add delegating handlers by type (#943) Jul 1, 2019
test allow to add delegating handlers by type (#943) Jul 1, 2019
tools hacked together load balancing reroutes in fileconfig (#211) Jan 31, 2018
.dockerignore Dockerfile build (#727) Dec 26, 2018
.editorconfig Feature/sticky sessions (#336) Apr 30, 2018
.gitignore Dockerfile build (#727) Dec 26, 2018
.travis.yml Upgrade Projects (#900) May 24, 2019
CODE_OF_CONDUCT.md Create CODE_OF_CONDUCT.md (#254) Mar 2, 2018
CONTRIBUTING.md Minor spelling issues (#489) Jul 23, 2018
Directory.Build.props [WIP] use HttpContext.RequestAborted to support cancel a request (#902) May 27, 2019
Dockerfile Upgraded to .NET Core 2.2 Runtime/Sdk (#950) Jul 1, 2019
GitVersion.yml hacked together load balancing reroutes in fileconfig (#211) Jan 31, 2018
ISSUE_TEMPLATE.md Minor spelling issues (#489) Jul 23, 2018
LICENSE.md hacked together load balancing reroutes in fileconfig (#211) Jan 31, 2018
Ocelot.sln kubernetes provider (#772) Jan 31, 2019
PULL_REQUEST_TEMPLATE.md Rename ULL_REQUEST_TEMPLATE.md to PULL_REQUEST_TEMPLATE.md Mar 2, 2018
README.md Update README.md May 22, 2019
ReleaseNotes.md #20 - added release notes to repo Jan 29, 2017
build-and-release-unstable.ps1 hacked together load balancing reroutes in fileconfig (#211) Jan 31, 2018
build-and-run-tests.ps1 hacked together load balancing reroutes in fileconfig (#211) Jan 31, 2018
build.cake Feat/monorepo (#734) Jan 7, 2019
build.ps1 Feat/monorepo (#734) Jan 7, 2019
build.sh updated dotnet core sdk and cake build script (#717) Dec 16, 2018
codeanalysis.ruleset Turn some of the rules back on. Mar 6, 2018
docker-compose.yaml Dockerfile build (#727) Dec 26, 2018
release.ps1 hacked together load balancing reroutes in fileconfig (#211) Jan 31, 2018
run-acceptance-tests.ps1 hacked together load balancing reroutes in fileconfig (#211) Jan 31, 2018
run-acceptance-tests.sh fix: LF for linux scripts (.sh) (#215) Feb 1, 2018
run-benchmarks.ps1 hacked together load balancing reroutes in fileconfig (#211) Jan 31, 2018
run-unit-tests.ps1 hacked together load balancing reroutes in fileconfig (#211) Jan 31, 2018
run-unit-tests.sh fix: LF for linux scripts (.sh) (#215) Feb 1, 2018
version.ps1 #20 - added cake build to do same functionality as batch scripts. Als… Jan 24, 2017

README.md

Build status Windows (AppVeyor)

Build Status Linux & OSX (Travis)

Build Status Windows

Build Status MacOS

Build Status Linux

Windows Build history

Coverage Status

Ocelot

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

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 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!

Features

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

  • Routing
  • Request Aggregation
  • Service Discovery with Consul & Eureka
  • Service Fabric
  • Kubernetes
  • WebSockets
  • Authentication
  • Authorisation
  • Rate Limiting
  • Caching
  • Retry policies / QoS
  • Load Balancing
  • Logging / Tracing / Correlation
  • Headers / Query String / Claims Transformation
  • Custom Middleware / Delegating Handlers
  • Configuration / Administration REST API
  • Platform / Cloud Agnostic

How to install

Ocelot is designed to work with ASP.NET Core only and it targets netstandard2.0. This means it can be used anywhere .NET Standard 2.0 is supported, including .NET Core 2.1 and .NET Framework 4.7.2 and up. 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

Or via the .NET Core CLI:

dotnet add package ocelot

All versions can be found here

Documentation

Please click here for the Ocelot 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

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 PRs. Sometimes it's worth getting in touch with us to discuss changes before doing any work incase 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 help wanted, small, medium and large effort. If you want to contribute for the first time I suggest looking at a help wanted & small effort issue :)

Donate

If you think this project is worth supporting financially please make a contribution using the button below!

Support via PayPal

Things that are currently annoying me

Get more details at codescene.io.

You can’t perform that action at this time.