mirror of
https://github.com/nsnail/Ocelot.git
synced 2025-04-21 05:12:50 +08:00
3ac9b3bd87
* hacked together load balancing reroutes in fileconfig * some renaming and refactoring * more renames * hacked away the old config json * test for issue 213 * renamed key * dont share ports * oops * updated docs * mvoed docs around * port being used
66 lines
2.9 KiB
Markdown
66 lines
2.9 KiB
Markdown
# Ocelot
|
|
|
|
[](https://ci.appveyor.com/project/TomPallister/ocelot-fcfpb)
|
|
|
|
[](https://coveralls.io/github/TomPallister/Ocelot?branch=develop)
|
|
|
|
Ocelot is a .NET Api Gateway. This project is aimed at people using .NET running
|
|
a micro services / service orientated architecture
|
|
that need a unified point of entry into their system.
|
|
|
|
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 stored in a per request scoped repository
|
|
and 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.
|
|
|
|
## How to install
|
|
|
|
Ocelot is designed to work with ASP.NET core only and is currently
|
|
built to netcoreapp2.0 [this](https://docs.microsoft.com/en-us/dotnet/articles/standard/library) 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`
|
|
|
|
All versions can be found [here](https://www.nuget.org/packages/Ocelot/)
|
|
|
|
## Documentation
|
|
|
|
Please click [here](http://ocelot.readthedocs.io/en/latest/) for the Ocleot 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](https://github.com/TomPallister/Ocelot/projects/1)
|
|
|
|
## Contributing
|
|
|
|
Pull requests, issues and commentary welcome! No special process just create a request and get in
|
|
touch either via gitter or create an issue.
|
|
|
|
|
|
## Things that are currently annoying me
|
|
|
|
+ The base OcelotMiddleware lets you access things that are going to be null
|
|
and doesnt check the response is OK. I think the fact you can even call stuff
|
|
that isnt available is annoying. Let alone it be null.
|
|
|
|
[ Get more details at **codescene.io**.](https://codescene.io/projects/697/jobs/latest-successful/results)
|
|
|
|
|
|
|