mirror of
https://gitee.com/iresty/apisix.git
synced 2024-12-15 01:11:58 +08:00
230 lines
6.5 KiB
Markdown
230 lines
6.5 KiB
Markdown
## 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.
|
|
|
|
[中文简介](README_CN.md)
|
|
|
|
## 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**
|
|
- **Dynamic Load Balancing**
|
|
- **Hash-based Load Balancing**
|
|
- **SSL**
|
|
- **Monitoring**
|
|
- **Forward Proxy**
|
|
- **Authentications**
|
|
- **Limit-rate**
|
|
- **Limit-count**
|
|
- **Limit-concurrency**
|
|
- **CLI**
|
|
- **REST API**
|
|
- **Clustering**
|
|
- **Scalability**
|
|
- **High performance**
|
|
- **Custom plugins**
|
|
- **Health Checks**: TODO.
|
|
- **Caching**: TODO.
|
|
- **Dashboard**: TODO.
|
|
- **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 18.04 | 1.15.8.1 | √ |
|
|
| Debian 9 | 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.5/apisix-0.5-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.
|
|
|
|
## Install APISIX Development Environment
|
|
|
|
If you are a developer, you can set up a local development environment with the following commands.
|
|
|
|
```shell
|
|
git clone git@github.com:iresty/apisix.git
|
|
cd apisix
|
|
make dev
|
|
```
|
|
|
|
If all goes well, you will see this message at the end:
|
|
|
|
> Stopping after installing dependencies for apisix
|
|
|
|
The following is the expected development environment directory structure:
|
|
|
|
```shell
|
|
$ tree -L 2 -d apisix
|
|
apisix
|
|
├── bin
|
|
├── conf
|
|
├── deps # dependent Lua and dynamic libraries
|
|
│ ├── lib64
|
|
│ └── share
|
|
├── doc
|
|
│ └── images
|
|
├── lua
|
|
│ └── apisix
|
|
├── t
|
|
│ ├── admin
|
|
│ ├── core
|
|
│ ├── lib
|
|
│ ├── node
|
|
│ └── plugin
|
|
└── utils
|
|
```
|
|
|
|
We can use more actions in the `make` command, for example:
|
|
|
|
```shell
|
|
$ make help
|
|
Makefile rules:
|
|
|
|
help: Show Makefile rules.
|
|
dev: Create a development ENV
|
|
check: Check Lua srouce code
|
|
init: Initialize the runtime environment
|
|
run: Start the apisix server
|
|
stop: Stop the apisix server
|
|
clean: Remove generated files
|
|
reload: Reload the apisix server
|
|
install: Install the apisix
|
|
```
|
|
|
|
## Quickstart
|
|
|
|
1. start server:
|
|
|
|
```shell
|
|
sudo apisix start
|
|
```
|
|
|
|
2. try limit count plugin
|
|
|
|
For the convenience of testing, we set up a maximum of 2 visits in 60 seconds,
|
|
and return 503 if the threshold is exceeded:
|
|
|
|
```shell
|
|
curl http://127.0.0.1:9080/apisix/admin/routes/1 -X PUT -d '
|
|
{
|
|
"uri": "/index.html",
|
|
"plugins": {
|
|
"limit-count": {
|
|
"count": 2,
|
|
"time_window": 60,
|
|
"rejected_code": 503,
|
|
"key": "remote_addr"
|
|
}
|
|
},
|
|
"upstream": {
|
|
"type": "roundrobin",
|
|
"nodes": {
|
|
"39.97.63.215:80": 1
|
|
}
|
|
}
|
|
}'
|
|
```
|
|
|
|
```shell
|
|
$ curl -i http://127.0.0.1:9080/index.html
|
|
HTTP/1.1 200 OK
|
|
Content-Type: text/html
|
|
Content-Length: 13175
|
|
Connection: keep-alive
|
|
X-RateLimit-Limit: 2
|
|
X-RateLimit-Remaining: 1
|
|
Server: APISIX web server
|
|
Date: Mon, 03 Jun 2019 09:38:32 GMT
|
|
Last-Modified: Wed, 24 Apr 2019 00:14:17 GMT
|
|
ETag: "5cbfaa59-3377"
|
|
Accept-Ranges: bytes
|
|
|
|
...
|
|
```
|
|
|
|
You can try more [plugins](doc/plugins.md) follow the documentation.
|
|
|
|
## 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.
|
|
|
|
## Documentation
|
|
|
|
English Development Documentation: TODO
|
|
|
|
[中文开发文档](doc/architecture-design-cn.md)
|
|
|
|
## Contributing
|
|
|
|
Contributions are welcomed and greatly appreciated.
|
|
|
|
## Acknowledgments
|
|
|
|
inspired by Kong and Orange.
|