Watch 12 Star 52 Fork 12

iresty / apisixLua

Sign up for free
Explore and code with more than 2 million developers,Free private repositories !:)
Sign up
Apisix 是一个基于云原生、高速可扩展的开源微服务网关节点实现,其自身主要优势是高性能和强大的扩展性 spread retract

  • Lua 87.6%
  • Terra 5.6%
  • Shell 2.7%
  • Perl 2.3%
  • Makefile 1.8%
Clone or download
Notice: Creating folder will generate an empty file .keep, because not support in Git



Build Status License Coverage Status

  • QQ group: 552030619
  • Gitter
  • Twitter

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.


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.


  • 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: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, JWT
  • Limit-req
  • Limit-count
  • Limit-concurrency
  • OpenTracing: Zipkin
  • Monitoring and Metrics: Prometheus
  • gRPC transcoding:Supports protocol transcoding so that clients can access your gRPC API by using HTTP/JSON.
  • Serverless: Invoke functions in each phase in APISIX.
  • 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.
  • Version Control: Supports rollbacks of operations.
  • CLI: start\stop\reload APISIX through the command line.
  • Proxy Websocket
  • IPv6: allow to use IPv6 to match route.
  • Clustering: APISIX nodes are stateless, creates clustering of the configuration center, please refer to etcd Clustering Guide.
  • Scalability: plug-in mechanism is easy to extend.
  • 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)
  • IP whitelist/blacklist
  • OAuth2.0: TODO.
  • ACL: TODO.
  • Bot detection: TODO.

Online Demo Dashboard

We provide an online dashboard demo version, make it easier for you to understand APISIX.


APISIX Installed and tested in the following systems:

OS OpenResty Status
CentOS 7
Ubuntu 16.04
Ubuntu 18.04
Debian 9

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

sudo yum install yum-utils
sudo yum-config-manager --add-repo
sudo yum install -y openresty etcd
sudo service etcd start

sudo yum install -y

You can try APISIX with the Quickstart now.

Install from Luarocks


APISIX is based on OpenResty, the configures data storage and distribution via etcd.

We recommend that you use luarocks to install APISIX, and for different operating systems have different dependencies, see more: Install Dependencies

Install APISIX

luarocks install --lua-dir=/usr/local/openresty/luajit apisix

If you got some error like unknow flag --lua-dir, this is because luarocks version is too low. We need to remove option lua-dir and run again: luarocks install 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 for more detailed information.


  1. start server:
sudo apisix start
  1. try limit count plugin

Limit count plugin is a good start to try APISIX, you can follow the documentation of limit count.

Then you can try more plugins.


APISIX has the built-in dashboard,open with a browser and try it.

Do not need to fill the user name and password, log in directly.

dashboard only allow by default, and you can modify allow_admin in conf/config.yaml by yourself, to add more IPs.


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 for more detailed information.

Architecture Design

English Development Documentation: TODO


Videos and slides


APISIX enriches the CNCF API Gateway Landscape:


There are often some questions asked by developers in the community. We have arranged them in the FAQ.

If your concerns are not among them, please submit issue to communicate with us.


Contributions are welcomed and greatly appreciated.


inspired by Kong and Orange.

Comments ( 3 )

You need to Sign in for post a comment


Help Search