https://github.com/fagongzi/manba

HTTP API Gateway
https://github.com/fagongzi/manba

api api-gateway backend-apis circuit-breaker etcd gateway go golang microservice proxy traffic-control

Last synced: 25 days ago
JSON representation

HTTP API Gateway

• Host: GitHub
• URL: https://github.com/fagongzi/manba
• Owner: fagongzi
• License: apache-2.0
• Created: 2016-04-25T09:17:37.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-07-12T07:59:34.000Z (over 1 year ago)
• Last Synced: 2024-04-18T12:27:49.464Z (7 months ago)
• Topics: api, api-gateway, backend-apis, circuit-breaker, etcd, gateway, go, golang, microservice, proxy, traffic-control
• Language: Go
• Homepage:
• Size: 34.4 MB
• Stars: 3,288
• Watchers: 184
• Forks: 761
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• go-awesome - Manba
• awesome-golang-repositories - manba

README

        


[![Gitter](https://badges.gitter.im/fagongzi/gateway.svg)](https://gitter.im/fagongzi/gateway?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)

[![Build Status](https://api.travis-ci.org/fagongzi/gateway.svg)](https://travis-ci.org/fagongzi/gateway)

[![Go Report Card](https://goreportcard.com/badge/github.com/fagongzi/gateway)](https://goreportcard.com/report/github.com/fagongzi/gateway)

Manba/[简体中文](README_CN.md)

-------

Manba is a restful API gateway based on HTTP, which can be used as a unified API access layer.

## Tutorial

A very detailed tutorial for beginners. [Link](./docs/tutorial.md)

Below are video tutorials.

Basics:

[![](https://img.youtube.com/vi/2qMWmdcw7o4/0.jpg)](https://www.youtube.com/watch?v=2qMWmdcw7o4)

Alternative bilibili.com video link: https://www.bilibili.com/video/av73432556/

Routing Configuration Tutorial:

[![](https://img.youtube.com/vi/D1pI6opB_ks/0.jpg)](https://www.youtube.com/watch?v=D1pI6opB_ks)

Alternative bilibili.com video link: https://www.bilibili.com/video/av73432836/

JWT Plugin Configuration Tutorial:

[![](https://img.youtube.com/vi/sLb16YDSlBs/0.jpg)](https://www.youtube.com/watch?v=sLb16YDSlBs)

Alternative bilibili.com video link: https://www.bilibili.com/video/av73433002/

## Attention

Please make sure your Go version is 1.10 or above. Otherwise, **undefined "math/rand".Shuffle** error will occur when compiling. [StackOverFlow Link](https://stackoverflow.com/questions/52172794/getting-undefined-rand-shuffle-in-golang)

## Features

* Traffic Control (on Server or API)

* Circuit Breaker (on Server or API)

* Load Balance

* Service Discovery

* Plugin

* Routing (Divert Traffic, Duplicate Traffic)

* API Aggregation

* API Argument Check

* API Access Control (White and Black List)

* API Default Return Value

* API Customized Return Value

* API Result Cache

* JWT Authorization

* API Metric Imports Prometheus

* API Retry After Failure

* Backend Server Health Check

* Open Management of API (GRPC、Restful)

* Websocket Support

* Online Data Migration Support

## Docker

The following content requires reader some knowledge of Docker. You can refer to [this book][2], or check out [the official documentation][1]。

### Available Docker Images

* `fagongzi/proxy`

   proxy component, `production ready`

* `fagongzi/apiserver`

   apiserver component, `production ready`

### Quick start with docker-compose

```bash

docker-compose up -d

```

Use `http://127.0.0.1:9093/ui/index.html` to access `apiserver`

Use `http://127.0.0.1` to access to your API

## Architecture

![](./images/arch.png)

## Web UI

Available Manba Web UI Projects：

* [Official](https://github.com/fagongzi/gateway-ui-vue)

* [gateway_ui (v2.x ONLY)](https://github.com/archfish/gateway_ui)

* [gateway_admin_ui](https://github.com/wilehos/gateway_admin_ui)

## Components

Manba consists of `proxy` and `apiserver`.

### Proxy

Proxy is a component which provides service to clients. Proxy is a stateless node. Multiple proxies can be deployed to handle huge traffic.

[More](./docs/proxy.md).

### ApiServer

ApiServer provides GRPC and Restful to manage metadata for users. ApiServer integrates  official Web UI.

[More](./docs/apiserver.md).

## Concepts of Manba

### Server

A server is a a real backend service.

[More](./docs/server.md).

### Cluster

Cluster consists of servers which provide the same service. A server is chosen to handle a specific request based on a load balance strategy.

[More](./docs/cluster.md).

### API

API is a key concept of Manba. We can manage external APIs in Manba and their distribution rules, aggregation rules and URL matching rules.

[More](./docs/api.md).

### Routing

Routing is a route strategy. Cookie, Querystring, Header and Path in HTTP Request dictate traffic distribution and traffic duplication to a specific cluster. Through this feature, AB test and online traffic divertion is achieved.

[More](./docs/routing.md).

## Getting Involved

[More](./docs/build.md)

## WeChat

![](./images/qr.jpg)

[1]: https://docs.docker.com/ "Docker Documentation"

[2]: https://github.com/yeasy/docker_practice "docker_practice"