Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/motiv-labs/janus

An API Gateway written in Go
https://github.com/motiv-labs/janus

api api-gateway engineering-experience-squad go microservices platform proxy reverse-proxy

Last synced: 1 day ago
JSON representation

An API Gateway written in Go

Host: GitHub
URL: https://github.com/motiv-labs/janus
Owner: motiv-labs
License: mit
Created: 2016-07-11T12:54:21.000Z (over 8 years ago)
Default Branch: master
Last Pushed: 2024-07-08T07:17:06.000Z (5 months ago)
Last Synced: 2024-12-04T21:05:38.963Z (8 days ago)
Topics: api, api-gateway, engineering-experience-squad, go, microservices, platform, proxy, reverse-proxy
Language: Go
Homepage: https://hellofresh.gitbooks.io/janus
Size: 2.83 MB
Stars: 2,802
Watchers: 209
Forks: 322
Open Issues: 49
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Codeowners: CODEOWNERS

Awesome Lists containing this project

awesome-distributed-system-projects - janus - a lightweight API gateway and management platform
awesome-repositories - motiv-labs/janus - An API Gateway written in Go (Go)

README

[![Build Status](https://travis-ci.org/hellofresh/janus.svg?branch=master)](https://travis-ci.org/hellofresh/janus)
[![codecov](https://codecov.io/gh/hellofresh/janus/branch/master/graph/badge.svg)](https://codecov.io/gh/hellofresh/janus)
[![GoDoc](https://godoc.org/github.com/hellofresh/janus?status.svg)](https://godoc.org/github.com/hellofresh/janus)
[![Go Report Card](https://goreportcard.com/badge/github.com/hellofresh/janus)](https://goreportcard.com/report/github.com/hellofresh/janus)
[![Join us on slack](https://img.shields.io/badge/chat-on%20slack-brightgreen.svg)](https://join.slack.com/t/janus-gw/shared_invite/enQtNTM1MDE3Mjg0ODIxLTVhNmQwODBmYTE1MmI5MDZiY2ZhN2ZmOGFiMGZmZTZmMzMxMTQ1MzA0NzY4ODA5Zjg1YzczNzg0ZjcwYjQwMjA)

> 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](https://en.wikipedia.org/wiki/Janus)

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

## 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](http://opentracing.io/) 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](https://hub.docker.com/repository/docker/hellofreshtech/janus) docker image included

## Installation

> Note: All examples here and in the documentation will be using [HTTPie](https://httpie.org/) 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](/examples) folder and you can find some good examples. All you got to do is:

```sh
cd examples/front-proxy

docker-compose up -d
```

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

Try the following command:

```sh
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](https://github.com/hellofresh/janus/releases) page and download the latest one for your platform.

## Getting Started

Check out our [quick start guide](https://hellofresh.gitbooks.io/janus/quick_start) to get up to speed with Janus.

## Contributing

To start contributing, please check [CONTRIBUTING](CONTRIBUTING.md).

## Documentation

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