2019-07-14 09:32:22 +08:00
[中文 ](README_CN.md )
2019-06-06 12:39:49 +08:00
## APISIX
2019-06-03 16:24:38 +08:00
[](https://travis-ci.org/iresty/apisix)
2019-05-28 16:26:30 +08:00
[](https://github.com/iresty/apisix/blob/master/LICENSE)
2019-07-03 15:54:14 +08:00
[](https://coveralls.io/github/iresty/apisix?branch=master)
2019-05-06 10:14:39 +08:00
2019-06-06 14:40:04 +08:00
- **QQ group**: 552030619
2019-06-30 22:06:01 +08:00
- [](https://gitter.im/apisix/community?utm_source=badge& utm_medium=badge& utm_campaign=pr-badge)
2019-07-03 14:47:05 +08:00
- [](https://twitter.com/intent/follow?screen_name=apisixfast)
2019-06-06 14:38:55 +08:00
## What's APISIX?
2019-05-06 10:14:39 +08:00
2019-06-06 14:38:55 +08:00
APISIX is a cloud-native microservices API gateway, delivering the ultimate performance, security, open source and scalable platform for all your APIs and microservices.
2019-06-05 17:28:50 +08:00
2019-06-13 12:34:43 +08:00
APISIX is based on OpenResty and etcd. Compared with traditional API gateways, APISIX has dynamic routing and plug-in hot loading, which is especially suitable for API management under micro-service system.
2019-05-20 11:07:03 +08:00
2019-06-13 12:34:43 +08:00
## Why APISIX?
2019-07-06 16:49:06 +08:00
2019-06-13 12:34:43 +08:00
If you are building a website, mobile device or IoT (Internet of Things) application, you may need to use an API gateway to handle interface traffic.
APISIX is a cloud-based microservices API gateway that handles traditional north-south traffic and handles east-west traffic between services.
APISIX provides dynamic load balancing, authentication, rate limiting, and other plugins through plugin mechanisms, and supports plugins you develop yourself.
2019-06-13 12:37:06 +08:00
For more detailed information, see the [White Paper ](https://www.iresty.com/download/Choosing%20the%20Right%20Microservice%20API%20Gateway%20for%20the%20Enterprise%20User.pdf ).
2019-06-13 12:34:43 +08:00
2019-06-30 22:06:01 +08:00
## Features
2019-07-06 16:49:06 +08:00
2019-08-01 11:29:22 +08:00
- **Cloud-Native**: Platform agnostic, No vendor lock-in, APISIX can run from bare-metal to Kubernetes.
- **hot updates and hot plugins**: Continuously updates its configurations and plugins without restarts!
2019-07-25 00:34:26 +08:00
- **Dynamic Load Balancing**: Round-robin load balancing with weight.
- **Hash-based Load Balancing**: Load balance with consistent hashing sessions.
2019-06-30 22:06:01 +08:00
- **SSL**
- **Forward Proxy**
2019-08-01 11:29:22 +08:00
- **[Health Checks](doc/health-check.md)**.
- **Circuit-Breaker**: Intelligent tracking of unhealthy upstream services.
- **Authentications**: [key-auth ](doc/plugins/key-auth.md ), [JWT ](doc/plugins/jwt-auth-cn.md )
- **[Limit-req](doc/plugins/limit-req.md)**
- **[Limit-count](doc/plugins/limit-count.md)**
- **[Limit-concurrency](doc/plugins/limit-conn.md)**
- **OpenTracing: [Zipkin ](doc/plugins/zipkin.md )**
- **Monitoring and Metrics**: [Prometheus ](doc/plugins/prometheus.md )
2019-08-01 12:51:28 +08:00
- **Custom plugins**: Allows hooking of common phases, such as `rewrite` , `access` , `header filer` , `body filter` and `log` , also allows to hook the `balancer` stage.
- **Dashboard**: Built-in dashboard to control APISIX.
2019-08-01 11:29:22 +08:00
- **CLI**: start\stop\reload APISIX through the command line.
2019-06-30 22:06:01 +08:00
- **REST API**
- **Clustering**
- **Scalability**
2019-08-01 11:29:22 +08:00
- **High performance**: The single-core QPS reaches 23800 with an average delay of less than 0.6 milliseconds.
2019-07-15 13:14:07 +08:00
- **Anti-ReDoS(Regular expression Denial of Service)**
2019-06-30 22:06:01 +08:00
- **OAuth2.0**: TODO.
- **ACL**: TODO.
- **Bot detection**: TODO.
2019-07-03 11:30:14 +08:00
- **IP blacklist**: TODO.
2019-06-17 11:59:31 +08:00
2019-05-28 16:26:30 +08:00
## Install
2019-06-05 15:25:58 +08:00
APISIX Installed and tested in the following systems:
2019-06-05 08:56:16 +08:00
2019-07-06 16:49:06 +08:00
| OS | OpenResty | Status |
| ------------ | --------- | ------ |
| CentOS 7 | 1.15.8.1 | √ |
2019-07-22 17:02:34 +08:00
| Ubuntu 16.04 | 1.15.8.1 | √ |
2019-07-06 16:49:06 +08:00
| Ubuntu 18.04 | 1.15.8.1 | √ |
| Debian 9 | 1.15.8.1 | √ |
2019-07-22 22:53:57 +08:00
| Mac OSX | 1.15.8.1 | √ |
2019-06-04 19:54:45 +08:00
You now have two ways to install APISIX: if you are using CentOS 7, it is recommended to use RPM, other systems please use Luarocks.
2019-06-04 17:58:01 +08:00
We will add support for Docker and more OS shortly.
2019-05-28 16:40:07 +08:00
2019-06-04 19:54:45 +08:00
### Install from RPM for CentOS 7
```shell
sudo yum install yum-utils
sudo yum-config-manager --add-repo https://openresty.org/package/centos/openresty.repo
sudo yum install -y openresty etcd
sudo service etcd start
2019-07-02 20:24:26 +08:00
sudo yum install -y https://github.com/iresty/apisix/releases/download/v0.5/apisix-0.5-0.el7.noarch.rpm
2019-06-04 19:54:45 +08:00
```
2019-06-05 06:59:04 +08:00
2019-06-04 19:54:45 +08:00
You can try APISIX with the [**Quickstart** ](#quickstart ) now.
### Install from Luarocks
#### Dependencies
2019-06-05 06:59:04 +08:00
2019-06-05 15:25:58 +08:00
APISIX is based on [OpenResty ](https://openresty.org/ ), the configures data storage and distribution via [etcd ](https://github.com/etcd-io/etcd ).
2019-06-05 06:59:04 +08:00
2019-06-20 17:41:54 +08:00
We recommend that you use [luarocks ](https://luarocks.org/ ) to install APISIX, and for different operating systems have different dependencies, see more: [Install Dependencies ](doc/install-dependencies.md )
2019-05-28 16:26:30 +08:00
2019-06-05 15:25:58 +08:00
#### Install APISIX
2019-06-02 20:46:52 +08:00
```shell
2019-07-07 08:24:21 +08:00
sudo luarocks install --lua-dir=/usr/local/openresty/luajit apisix
2019-06-02 20:46:52 +08:00
```
2019-06-04 17:58:01 +08:00
If all goes well, you will see the message like this:
2019-07-06 16:49:06 +08:00
2019-06-04 17:58:01 +08:00
> apisix is now built and installed in /usr (license: Apache License 2.0)
Congratulations, you have already installed APISIX successfully.
2019-05-20 11:07:03 +08:00
2019-07-18 16:09:30 +08:00
## Development Manual of APISIX
2019-06-17 11:59:31 +08:00
2019-07-18 16:09:30 +08:00
If you are a developer, you can view the [dev manual ](doc/dev-manual.md ) for more detailed information.
2019-07-05 19:01:20 +08:00
2019-05-28 16:26:30 +08:00
## Quickstart
2019-06-04 17:00:37 +08:00
1. start server:
2019-07-06 16:49:06 +08:00
2019-05-28 16:26:30 +08:00
```shell
2019-06-04 17:00:37 +08:00
sudo apisix start
2019-05-28 16:26:30 +08:00
```
2019-06-04 17:00:37 +08:00
2. try limit count plugin
2019-05-28 16:26:30 +08:00
2019-07-18 16:09:30 +08:00
Limit count plugin is a good start to try APISIX,
you can follow the [documentation of limit count ](doc/plugins/limit-count.md ).
2019-05-28 16:26:30 +08:00
2019-07-18 16:09:30 +08:00
You can try more [plugins ](doc/plugins.md ).
2019-06-30 22:06:01 +08:00
2019-05-31 16:37:26 +08:00
## Benchmark
2019-07-06 16:49:06 +08:00
2019-06-06 14:38:55 +08:00
Using Google Cloud's 4 core server, APISIX's QPS reach to 60,000 with a latency of only 500 microseconds.
2019-06-06 14:40:04 +08:00
2019-06-06 14:38:55 +08:00
You can view the [benchmark documentation ](doc/benchmark.md ) for more detailed information.
2019-06-05 09:31:32 +08:00
2019-07-18 16:09:30 +08:00
## Architecture Design
2019-07-18 07:48:41 +08:00
2019-07-18 16:09:30 +08:00
English Development Documentation: TODO
2019-07-18 07:48:41 +08:00
2019-07-18 16:09:30 +08:00
[中文开发文档 ](doc/architecture-design-cn.md )
2019-07-18 07:48:41 +08:00
2019-07-31 22:42:17 +08:00
## Videos and slides
- [APISIX technology selection, testing and continuous integration(Chinese) ](https://www.upyun.com/opentalk/432.html )
- [APISIX high performance practice(Chinese) ](https://www.upyun.com/opentalk/429.html )
2019-07-18 16:09:30 +08:00
## Landscape
2019-07-06 16:49:06 +08:00
2019-07-18 16:09:30 +08:00
APISIX enriches the [CNCF API Gateway Landscape ](https://landscape.cncf.io/category=api-gateway&format=card-mode&grouping=category ):
2019-06-06 14:40:04 +08:00
2019-07-18 16:19:14 +08:00
2019-05-28 16:26:30 +08:00
2019-06-06 14:38:55 +08:00
## Contributing
2019-07-06 16:49:06 +08:00
2019-06-06 14:38:55 +08:00
Contributions are welcomed and greatly appreciated.
2019-06-04 15:20:41 +08:00
2019-06-06 14:38:55 +08:00
## Acknowledgments
2019-07-06 16:49:06 +08:00
2019-07-04 21:17:33 +08:00
inspired by Kong and Orange.
