English

APISIX

Build Status License

  • QQ 交流群: 552030619
  • Gitter

什么是 APISIX？

APISIX 是一个云原生、高性能、可扩展的微服务 API 网关。

它是基于 OpenResty 和 etcd 来实现，和传统 API 网关相比，APISIX 具备动态路由和插件热加载，特别适合微服务体系下的 API 管理。

为什么选择 APISIX？

如果你正在构建网站、移动设备或 IoT（物联网）的应用，那么你可能需要使用 API 网关来处理接口流量。

APISIX 是基于云原生的微服务 API 网关，可以处理传统的南北向流量，也可以处理服务间的东西向流量。

APISIX 通过插件机制，提供动态负载平衡、身份验证、限流限速等功能，并且支持你自己开发的插件。

更多详细的信息，可以查阅 APISIX 的白皮书

功能

  • 云原生: 平台无关，没有供应商锁定，无论裸机还是 Kubernetes，APISIX 都可以运行。
  • 热更新和热插件: 无需重启服务，就可以持续的更新配置和插件!
  • 动态负载均衡：支持权重的 round-robin 负载平衡。
  • 支持一致性 hash 的负载均衡：支持一致性 hash 的负载均衡。
  • SSL
  • 反向代理
  • 监控检查.
  • 熔断器: 智能跟踪不健康上游服务.
  • 身份认证: key-auth, JWT。
  • 限制速率
  • 限制请求数
  • 限制并发
  • OpenTracing: Zipkin
  • 监控和指标: Prometheus
  • 自定义插件: 允许挂载常见阶段，例如rewrite，access，header filer，body filter和log，还允许挂载 balancer 阶段。
  • 控制台: 内置控制台来操作 APISIX 集群。
  • CLI: 使用命令行来启动、关闭和重启 APISIX。
  • REST API
  • 集群
  • 可扩展
  • 高性能：在单核上 QPS 可以达到 23800，同时延迟只有 0.6 毫秒。
  • 防御 ReDoS(正则表达式拒绝服务)
  • OAuth2.0: TODO.
  • ACL: TODO.
  • Bot detection: TODO.
  • IP 黑名单: TODO.

安装

APISIX 在以下操作系统中做过安装和运行测试:

操作系统OpenResty状态
CentOS 71.15.8.1√
Ubuntu 16.041.15.8.1√
Ubuntu 18.041.15.8.1√
Debian 91.15.8.1√
Mac OSX1.15.8.1√

现在有两种方式来安装: 如果你是 CentOS 7 的系统，推荐使用 RPM 包安装；其他的系统推荐使用 Luarocks 安装。

通过 RPM 包安装（CentOS 7）

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

如果安装成功，就可以参考 快速上手 来进行体验。如果失败，欢迎反馈给我们。

通过 Luarocks 安装

依赖项

APISIX 是基于 openresty 之上构建的, 配置数据的存储和分发是通过 etcd 来完成。

我们推荐你使用 luarocks 来安装 APISIX，不同的操作系统发行版本有不同的依赖和安装步骤，具体可以参考: 安装前的依赖

安装 APISIX

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

如果一切顺利，你会在最后看到这样的信息：

apisix is now built and installed in /usr (license: Apache License 2.0)

恭喜你，APISIX 已经安装成功了。

开发环境

如果你是一个开发者，可以从 开发文档 中获取搭建开发环境和运行测试案例的步骤.

快速上手

  1. 启动 APISIX
sudo apisix start
  1. 测试限流插件

你可以测试限流插件，来上手体验 APISIX，按照限流插件的文档步骤即可.

你可以跟着文档来尝试更多的插件.

性能测试

使用谷歌云的 4 核心服务器来运行 APISIX，QPS 可以达到 60000，同时延时只有 0.5 毫秒。

你可以看出性能测试文档来了解更多详细内容。

架构设计

详细设计文档

视频和幻灯片

全景图

APISIX 被纳入 云原生软件基金会 API 网关全景图:

参与社区

如果你对 APISIX 的开发和使用感兴趣，欢迎加入我们的 QQ 群来交流:

致谢

灵感来自 Kong 和 Orange。