janus

README

---

Note: This project is in maintenance mode. There will be bug fixes, but no feature development.

---

An API Gateway written in Go

This is a lightweight API Gateway and Management Platform that enables you to control who accesses your API, when they access it and how they access it. Janus will also record detailed analytics on how your users are interacting with your API and when things go wrong.

Go version 1.9 or later is required to build master, the current development version. Janus is officially supported on linux/amd64, linux/i386, linux/arm64, darwin/i386, darwin/amd64, windows/i386 and windows/amd64.

Why Janus?

In ancient Roman religion and myth, Janus (/ˈdʒeɪnəs/; Latin: Ianus, pronounced [ˈjaː.nus]) is the god of beginnings, gates, transitions, time, doorways, passages, and endings. He is usually depicted as having two faces since he looks to the future and to the past. Wikipedia

We thought it would be nice to name the project after the God of the Gates 😄

What is an API Gateway?

An API Gateway sits in front of your application(s) and/or services and manages the heavy lifting of authorisation, access control and throughput limiting to your services. Ideally, it should mean that you can focus on creating services instead of implementing management infrastructure. For example, if you have written a really awesome web service that provides geolocation data for all the cats in NYC, and you want to make it public, integrating an API gateway is a faster, more secure route than writing your own authorisation middleware.

Key Features

This API Gateway offers powerful, yet lightweight features that allows fine-grained control over your API ecosystem.

• No dependency hell, single binary made with go
• REST API, full programatic access to the internals makes it easy to manage your API users, keys and API Configuration from within your systems
• Hot-reloading of configuration. No need to restart the process
• Graceful shutdown of http connections
• OpenTracing support for Distributed tracing (Supports Google Cloud Platform and Jaeger)
• HTTP/2 support
• Circuit Breaker support that can be configured for each API
• Retry mechanism to make your endpoints more resilient
• Rate Limiting, easily rate limit your API users, rate limiting is granular and can be applied on a per-key basis
• CORS Filter, enable cors for your API, or even for specific endpoints
• Multiple auth protocols, out of the box, we support JWT, OAuth 2.0 and Basic Auth access methods
• Small official docker image included

Installation

Note: All examples here and in the documentation will be using HTTPie for simplicity. But all requests can easily be converted to curl if needed.

Docker

The simplest way of installing Janus is to run the docker image for it. You can check our examples folder and you can find some good examples. All you got to do is:

cd examples/front-proxy

docker-compose up -d

Now you should be able to get a response from the gateway.

Try the following command:

http http://localhost:8081

Manual

You can get the binary and play with it in your own environment (or even deploy it where ever you like). Just go to the releases page and download the latest one for your platform.

Getting Started

Check out our quick start guide to get up to speed with Janus.

Contributing

To start contributing, please check CONTRIBUTING.

Documentation

• Janus Docs: https://hellofresh.gitbooks.io/janus
• Janus Go Docs: https://godoc.org/github.com/hellofresh/janus
• Go lang: https://golang.org/

Documentation

Overview

Package janus is a lightweight, API Gateway and Management Platform enables you to control who accesses your API, when they access it and how they access it. API Gateway will also record detailed analytics on how your users are interacting with your API and when things go wrong.

For a full guide visit https://github.com/hellofresh/janus