mirror of
https://github.com/nsnail/Ocelot.git
synced 2025-04-22 10:12:51 +08:00
bit of a hack to increment build
This commit is contained in:
Tom Gardham-Pallister
parent
a55c75efdc
commit
7ed058687d
182
README.md
182
README.md
@ -1,91 +1,91 @@
|
||||
[<img src="http://threemammals.com/images/ocelot_logo.png">](http://threemammals.com/ocelot)
|
||||
|
||||
[](https://ci.appveyor.com/project/TomPallister/ocelot-fcfpb) Windows (AppVeyor)
|
||||
[](https://travis-ci.org/ThreeMammals/Ocelot) Linux & OSX (Travis)
|
||||
|
||||
[](https://ci.appveyor.com/project/TomPallister/ocelot-fcfpb/history?branch=develop)
|
||||
|
||||
[](https://coveralls.io/github/ThreeMammals/Ocelot?branch=develop)
|
||||
|
||||
# Ocelot
|
||||
|
||||
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. 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](http://ocelot.readthedocs.io/en/latest/).
|
||||
|
||||
* Routing
|
||||
* Request Aggregation
|
||||
* Service Discovery with Consul & Eureka
|
||||
* Service Fabric
|
||||
* 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.0` and `.NET Framework 4.6.1` and up. [This](https://docs.microsoft.com/en-us/dotnet/standard/net-standard) 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/ThreeMammals/Ocelot/issues).
|
||||
|
||||
## Contributing
|
||||
|
||||
We love to receive contributions from the community so please keep them coming :)
|
||||
|
||||
Pull requests, issues and commentary welcome!
|
||||
|
||||
Please complete the relavent 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 contriute for the first time I suggest looking at a help wanted & small effort issue :)
|
||||
|
||||
## Things that are currently annoying me
|
||||
|
||||
[ Get more details at **codescene.io**.](https://codescene.io/projects/697/jobs/latest-successful/results)
|
||||
|
||||
|
||||
|
||||
[<img src="http://threemammals.com/images/ocelot_logo.png">](http://threemammals.com/ocelot)
|
||||
|
||||
[](https://ci.appveyor.com/project/TomPallister/ocelot-fcfpb) Windows (AppVeyor)
|
||||
[](https://travis-ci.org/ThreeMammals/Ocelot) Linux & OSX (Travis)
|
||||
|
||||
[](https://ci.appveyor.com/project/TomPallister/ocelot-fcfpb/history?branch=develop)
|
||||
|
||||
[](https://coveralls.io/github/ThreeMammals/Ocelot?branch=develop)
|
||||
|
||||
# Ocelot
|
||||
|
||||
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. 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](http://ocelot.readthedocs.io/en/latest/).
|
||||
|
||||
* Routing
|
||||
* Request Aggregation
|
||||
* Service Discovery with Consul & Eureka
|
||||
* Service Fabric
|
||||
* 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.0` and `.NET Framework 4.6.1` and up. [This](https://docs.microsoft.com/en-us/dotnet/standard/net-standard) 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/ThreeMammals/Ocelot/issues).
|
||||
|
||||
## Contributing
|
||||
|
||||
We love to receive contributions from the community so please keep them coming :)
|
||||
|
||||
Pull requests, issues and commentary welcome!
|
||||
|
||||
Please complete the relavent 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 contriute for the first time I suggest looking at a help wanted & small effort issue :)
|
||||
|
||||
## Things that are currently annoying me
|
||||
|
||||
[ Get more details at **codescene.io**.](https://codescene.io/projects/697/jobs/latest-successful/results)
|
||||
|
||||
|
||||
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user