mirror of
https://gitee.com/iresty/apisix.git
synced 2024-12-15 09:21:26 +08:00
171 lines
6.7 KiB
Markdown
171 lines
6.7 KiB
Markdown
[中文](README_CN.md)
|
||
## APISIX
|
||
|
||
[](https://travis-ci.org/iresty/apisix)
|
||
[](https://github.com/iresty/apisix/blob/master/LICENSE)
|
||
[](https://coveralls.io/github/iresty/apisix?branch=master)
|
||
|
||
- **QQ group**: 552030619
|
||
- [](https://gitter.im/apisix/community?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge)
|
||
- [](https://twitter.com/intent/follow?screen_name=apisixfast)
|
||
|
||
## What's APISIX?
|
||
|
||
APISIX is a cloud-native microservices API gateway, delivering the ultimate performance, security, open source and scalable platform for all your APIs and microservices.
|
||
|
||
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.
|
||
|
||
|
||
## Why APISIX?
|
||
|
||
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.
|
||
|
||
For more detailed information, see the [White Paper](https://www.iresty.com/download/Choosing%20the%20Right%20Microservice%20API%20Gateway%20for%20the%20Enterprise%20User.pdf).
|
||
|
||
|
||
|
||
## Features
|
||
|
||
- **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!
|
||
- **Dynamic Load Balancing**: Round-robin load balancing with weight.
|
||
- **Hash-based Load Balancing**: Load balance with consistent hashing sessions.
|
||
- **SSL**: Dynamically load an SSL certificate.
|
||
- **Forward Proxy**
|
||
- **[Health Checks](doc/health-check.md)**：Enable health check on the upstream node, and will automatically filter unhealthy nodes during load balancing to ensure system stability.
|
||
- **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)
|
||
- **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.
|
||
- **CLI**: start\stop\reload APISIX through the command line.
|
||
- **REST API**
|
||
- **Clustering**
|
||
- **Scalability**
|
||
- **High performance**: The single-core QPS reaches 24k with an average delay of less than 0.6 milliseconds.
|
||
- **Anti-ReDoS(Regular expression Denial of Service)**
|
||
- **OAuth2.0**: TODO.
|
||
- **ACL**: TODO.
|
||
- **Bot detection**: TODO.
|
||
- **IP blacklist**: TODO.
|
||
|
||
## Install
|
||
|
||
APISIX Installed and tested in the following systems:
|
||
|
||
| OS | OpenResty | Status |
|
||
| ------------ | --------- | ------ |
|
||
| CentOS 7 | 1.15.8.1 | √ |
|
||
| Ubuntu 16.04 | 1.15.8.1 | √ |
|
||
| Ubuntu 18.04 | 1.15.8.1 | √ |
|
||
| Debian 9 | 1.15.8.1 | √ |
|
||
| Mac OSX | 1.15.8.1 | √ |
|
||
|
||
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.
|
||
|
||
We will add support for Docker and more OS shortly.
|
||
|
||
### 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
|
||
|
||
sudo yum install -y https://github.com/iresty/apisix/releases/download/v0.6/apisix-0.6-0.el7.noarch.rpm
|
||
```
|
||
|
||
You can try APISIX with the [**Quickstart**](#quickstart) now.
|
||
|
||
### Install from Luarocks
|
||
|
||
#### Dependencies
|
||
|
||
APISIX is based on [OpenResty](https://openresty.org/), the configures data storage and distribution via [etcd](https://github.com/etcd-io/etcd).
|
||
|
||
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)
|
||
|
||
#### Install APISIX
|
||
|
||
```shell
|
||
sudo luarocks install --lua-dir=/usr/local/openresty/luajit apisix
|
||
```
|
||
|
||
If all goes well, you will see the message like this:
|
||
|
||
> apisix is now built and installed in /usr (license: Apache License 2.0)
|
||
|
||
Congratulations, you have already installed APISIX successfully.
|
||
|
||
## Development Manual of APISIX
|
||
|
||
If you are a developer, you can view the [dev manual](doc/dev-manual.md) for more detailed information.
|
||
|
||
## Quickstart
|
||
|
||
1. start server:
|
||
|
||
```shell
|
||
sudo apisix start
|
||
```
|
||
|
||
2. try limit count plugin
|
||
|
||
Limit count plugin is a good start to try APISIX,
|
||
you can follow the [documentation of limit count](doc/plugins/limit-count.md).
|
||
|
||
Then you can try more [plugins](doc/plugins.md).
|
||
|
||
## Dashboard
|
||
APISIX has the built-in dashboard，open `http://127.0.0.1:9080/apisix/dashboard` with a browser and try it.
|
||
|
||
Do not need to fill the user name and password, log in directly.
|
||
|
||
dashboard only allow `127.0.0.0/24` by default, and you can modify `allow_admin` in `conf/config.yaml` by yourself, to add more IPs.
|
||
|
||
## Benchmark
|
||
|
||
Using Google Cloud's 4 core server, APISIX's QPS reach to 60,000 with a latency of only 500 microseconds.
|
||
|
||
You can view the [benchmark documentation](doc/benchmark.md) for more detailed information.
|
||
|
||
## Architecture Design
|
||
|
||
English Development Documentation: TODO
|
||
|
||
[中文开发文档](doc/architecture-design-cn.md)
|
||
|
||
## 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)
|
||
|
||
## Landscape
|
||
|
||
APISIX enriches the [CNCF API Gateway Landscape](https://landscape.cncf.io/category=api-gateway&format=card-mode&grouping=category):
|
||
|
||
|
||
|
||
## FAQ
|
||
There are often some questions asked by developers in the community. We have arranged them in the [FAQ](FAQ.md).
|
||
|
||
If your concerns are not among them, please submit issue to communicate with us.
|
||
|
||
## Contributing
|
||
|
||
Contributions are welcomed and greatly appreciated.
|
||
|
||
## Acknowledgments
|
||
|
||
inspired by Kong and Orange.
|