DZone
Thanks for visiting DZone today,
Edit Profile
  • Manage Email Subscriptions
  • How to Post to DZone
  • Article Submission Guidelines
Sign Out View Profile
  • Post an Article
  • Manage My Drafts
Over 2 million developers have joined DZone.
Log In / Join
Refcards Trend Reports Events Over 2 million developers have joined DZone. Join Today! Thanks for visiting DZone today,
Edit Profile Manage Email Subscriptions Moderation Admin Console How to Post to DZone Article Submission Guidelines
View Profile
Sign Out
Refcards
Trend Reports
Events
Zones
Culture and Methodologies Agile Career Development Methodologies Team Management
Data Engineering AI/ML Big Data Data Databases IoT
Software Design and Architecture Cloud Architecture Containers Integration Microservices Performance Security
Coding Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
Culture and Methodologies
Agile Career Development Methodologies Team Management
Data Engineering
AI/ML Big Data Data Databases IoT
Software Design and Architecture
Cloud Architecture Containers Integration Microservices Performance Security
Coding
Frameworks Java JavaScript Languages Tools
Testing, Deployment, and Maintenance
Deployment DevOps and CI/CD Maintenance Monitoring and Observability Testing, Tools, and Frameworks
  1. DZone
  2. Data Engineering
  3. Databases
  4. Ocelot: The API Gateway Framework for .NET

Ocelot: The API Gateway Framework for .NET

When building a large and complex system using the microservices architecture with multiple client apps, a good approach to consider is API Gateway Pattern.

Thiago Loureiro user avatar by
Thiago Loureiro
·
Jan. 08, 19 · Opinion
Like (7)
Save
Tweet
Share
35.02K Views

Join the DZone community and get the full member experience.

Join For Free

First of All, What Is an API Gateway?

An API Gateway is basically an interface in which it receives calls and redirects to internal services. Basically, it is used for the following purposes:

  • Filtering
  • Traffic Routing
  • Security Mechanism
  • Expose only one endpoint

API Gateway Pattern

When building a large and complex system using the microservices architecture with multiple client apps, a good approach to consider is API Gateway Pattern.

This pattern provides a single entry-point for group(s) of microservices. A variation of the API Gateway pattern is also known as the “backend for frontend” (BFF) because you might create multiple API Gateways depending on the different needs from each client app.

Therefore, the API Gateway sits between the client apps and the microservices. It acts as a reverse proxy, routing requests from clients to services.

It can also provide additional cross-cutting features such as authentication, SSL termination, and cache.

Ocelot

Now, let's talk our main subject, Ocelot:

Ocelot is an API Gateway for .NET platform. This project is intended for people using .NET/Core running a micro service/service oriented architecture that needs a unified entry point on their system. However, it will work with anything that uses HTTP and runs on any platform supported by ASP.NET Core.

In my POC with Ocelot I've been very successful in different scenarios, I have been testing Load Balancing, Caching, Routing, Authentication (with JWT) and Service Discovery with very powerful tool (Consul.io).

If you are looking for an API Gateway solution I recommend take a look into Ocelot, I added in this article links to Ocelot documentation and POC that I've created with .NET Core 2.1

It's good to mention that Ocelot is an OpenSource project, I am part of the Three Mammals team, contributing to the tool/platform with bugfixes, and improvements, so if you're a contributor, feel free to create some PR's, I will be happy to check it out!

Ocelot Features:

  • Routing
  • Request Aggregation
  • Service Discovery with Consul & Eureka
  • Service Fabric
  • WebSockets
  • Authentication
  • Authorization
  • 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

More information can be found here:

http://threemammals.com/ocelot

API Gateway with Ocelot POC

https://github.com/thiagoloureiro/APIGatewayOcelot

Ocelot GitHub Repo:

https://github.com/ThreeMammals/Ocelot

API Framework

Opinions expressed by DZone contributors are their own.

Popular on DZone

  • Beginners’ Guide to Run a Linux Server Securely
  • AWS Cloud Migration: Best Practices and Pitfalls to Avoid
  • Easy Smart Contract Debugging With Truffle’s Console.log
  • Using the PostgreSQL Pager With MariaDB Xpand

Comments

Partner Resources

X

ABOUT US

  • About DZone
  • Send feedback
  • Careers
  • Sitemap

ADVERTISE

  • Advertise with DZone

CONTRIBUTE ON DZONE

  • Article Submission Guidelines
  • Become a Contributor
  • Visit the Writers' Zone

LEGAL

  • Terms of Service
  • Privacy Policy

CONTACT US

  • 600 Park Offices Drive
  • Suite 300
  • Durham, NC 27709
  • support@dzone.com
  • +1 (919) 678-0300

Let's be friends: