English

APISIX

• QQ 交流群: 552030619
• 邮件列表: 发邮件到 dev-subscribe@apisix.apache.org, 然后跟着回复邮件操作即可
• APISIX 是一个云原生、高性能、可扩展的微服务 API 网关。

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

安装 | 文档 | 开发环境 | FAQ

为什么选择 APISIX？

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

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

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

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

功能

• 云原生: 平台无关，没有供应商锁定，无论裸机还是 Kubernetes，APISIX 都可以运行。
• 热更新和热插件: 无需重启服务，就可以持续更新配置和插件。
• 动态负载均衡：动态支持有权重的 round-robin 负载平衡。
• 支持一致性 hash 的负载均衡：动态支持一致性 hash 的负载均衡。
• SSL：动态加载 SSL 证书。
• HTTP(S) 反向代理
• 健康检查：启用上游节点的健康检查，将在负载均衡期间自动过滤不健康的节点，以确保系统稳定性。
• 熔断器: 智能跟踪不健康上游服务。
• 身份认证: key-auth, JWT。
• 限制速率
• 限制请求数
• 限制并发
• 代理请求重写: 支持重写请求上游的host、uri、schema、enable_websocket、headers信息。
• OpenTracing: 支持 Apache Skywalking 和 Zipkin
• 监控和指标: Prometheus
• gRPC 代理：通过 APISIX 代理 gRPC 连接，并使用 APISIX 的大部分特性管理你的 gRPC 服务。
• gRPC 协议转换：支持协议的转换，这样客户端可以通过 HTTP/JSON 来访问你的 gRPC API。
• Serverless: 在 APISIX 的每一个阶段，你都可以添加并调用自己编写的函数。
• 自定义插件: 允许挂载常见阶段，例如rewrite，access，header filer，body filter和log，还允许挂载 balancer 阶段。
• 控制台: 内置控制台来操作 APISIX 集群。
• 版本控制：支持操作的多次回滚。
• CLI: 使用命令行来启动、关闭和重启 APISIX。
• REST API
• Websocket 代理
• IPv6：支持使用 IPv6 格式匹配路由。
• 集群：APISIX 节点是无状态的，创建配置中心集群请参考 etcd Clustering Guide。
• 可扩展：简单易用的插件机制方便扩展。
• 高性能：在单核上 QPS 可以达到 24k，同时延迟只有 0.6 毫秒。
• 防御 ReDoS(正则表达式拒绝服务)
• IP 黑名单
• IdP 支持: 支持外部的身份认证服务，比如 Auth0，Okta，Authing 等，用户可以借此来对接 Oauth2.0 等认证方式。
• 单机模式: 支持从本地配置文件中加载路由规则，在 kubernetes(k8s) 等环境下更友好。
• 全局规则：允许对所有请求执行插件，比如黑白名单、限流限速等。
• TCP/UDP 代理: 动态 TCP/UDP 代理。
• 动态 MQTT 代理: 支持用 client_id 对 MQTT 进行负载均衡，同时支持 MQTT 3.1.* 和 5.0 两个协议标准。
• ACL: TODO。
• Bot detection: TODO。

在线演示版本

我们部署了一个在线的 dashboard ，方便您了解 APISIX。

安装

APISIX 在以下操作系统中可顺利安装并做过运行测试，需要注意的是：OpenResty 的版本必须 >= 1.15.8.1：

• CentOS 7
• Ubuntu 16.04
• Ubuntu 18.04
• Debian 9
• Debian 10
• macOS
• ARM64 Ubuntu 18.04

目前有 4 种安装方式:

• 如果你在使用 CentOS 7，我们推荐使用 RPM 包安装；
• 在 macOS 中，你需要克隆该仓库并手动安装，请参考开发手册；
• 其它操作系统，我们推荐使用 Luarocks 安装方式；
• 你也可以使用 Docker 镜像 来安装。

安装 APISIX 的主要步骤：

1. 运行时依赖：OpenResty 或 Tengine。

   • OpenResty: 参考 http://openresty.org/en/installation.html。
   • Tengine：参考该安装脚本 Install Tengine at Ubuntu。

2. 配置存储中心：参考 etcd。

   NOTE：APISIX 目前仅支持 etcd 的 v2 协议存储，但最新版的 etcd (3.4 开始）已经默认关闭 v2 协议。 在启动参数中添加 --enable-v2=true，启用 v2 协议。支持 etcd 的 v3 协议开发工作已经开始，很快就能与大家见面。

3. 安装 APISIX 服务。

通过 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/apache/incubator-apisix/releases/download/v0.8/apisix-0.8-0.el7.noarch.rpm

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

通过 Luarocks 安装 （不支持 macOS）

依赖项

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

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

安装 APISIX

在终端中执行下面命令完成 APISIX 的安装：

通过脚本安装 master 分支的代码

sudo sh -c "$(curl -fsSL https://raw.githubusercontent.com/apache/incubator-apisix/master/utils/install-apisix.sh)"

通过 Luarocks 安装指定的版本:

# 安装 apisix 的 0.8 版本
sudo luarocks install --lua-dir=/path/openresty/luajit apisix 0.8

# 老版本 luarocks 可能不支持 `lua-dir` 参数，可以删除该选项
sudo luarocks install apisix 0.8

安装完成

    apisix 0.7-0 is now built and installed in /usr/local/apisix/deps (license: Apache License 2.0)

    + sudo rm -f /usr/local/bin/apisix
    + sudo ln -s /usr/local/apisix/deps/bin/apisix /usr/local/bin/apisix

恭喜，APISIX 已经安装成功。

开发环境

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

快速上手

1. 启动 APISIX

sudo apisix start

注意：如果你当前在开发环境下，应使用 make run 命令启动服务。

2. 测试限流插件

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

更进一步，你可以跟着文档来尝试更多的插件。

控制台

APISIX 内置了 dashboard，使用浏览器打开 http://127.0.0.1:9080/apisix/dashboard/ 即可使用， 不用填写用户名和密码，直接登录。

Dashboard 默认允许任何 IP 访问。你可以自行修改 conf/config.yaml 中的 allow_admin 字段，指定允许访问 dashboard 的 IP 列表。

性能测试

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

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

架构设计

详细设计文档

视频和文章

• 2019.10.30 Apache APISIX 微服务架构极致性能架构解析 .
• 2019.8.31 APISIX 技术选型、测试和持续集成 .
• 2019.8.31 APISIX 高性能实战2 .
• 2019.7.6 APISIX 高性能实战(Chinese) .

APISIX 的用户有哪些？

有很多公司和组织把 APISIX 用户学习、研究、生产环境和商业产品中。下面是 APISIX 的用户墙：

欢迎用户把自己加入到 Powered By 页面。

全景图

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

常见问题（FAQ）

在社区中经常会有开发者问到的一些问题，我们整理在下面这份 FAQ 中：

如果你关心的问题没有在其中，欢迎提交 issue 或者加入下面的 QQ 群和我们沟通。

参与社区

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

致谢

灵感来自 Kong 和 Orange。