构建 Apache APISIX

1. 安装依赖

Apache APISIX 的运行环境需要 Nginx 和 etcd,

所以在安装前,请根据不同的操作系统来安装依赖

2. 安装 Apache APISIX

你可以通过源码包、Docker、Luarocks 等多种方式来安装 Apache APISIX。

通过源码包安装

你需要先下载 Apache Release 源码包:

  1. wget http://www.apache.org/dist/apisix/1.5/apache-apisix-1.5-src.tar.gz
  2. tar zxvf apache-apisix-1.5-src.tar.gz

安装运行时依赖的 Lua 库:

  1. cd apache-apisix-1.5
  2. make deps

通过 RPM 包安装(CentOS 7)

  1. sudo yum install -y https://github.com/apache/apisix/releases/download/1.5/apisix-1.5-0.el7.noarch.rpm

通过 Luarocks 安装 (不支持 macOS)

在终端中执行下面命令完成 APISIX 的安装(只推荐开发者使用):

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

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

通过 Luarocks 安装指定的版本:

  1. # 安装 apisix 的 1.5 版本
  2. sudo luarocks install --lua-dir=/path/openresty/luajit apisix 1.5
  3. # 老版本 luarocks 可能不支持 `lua-dir` 参数,可以删除该选项
  4. sudo luarocks install apisix 1.5

3. 管理(启动、关闭等)APISIX 服务

我们可以在 apisix 的目录下用 make run 命令来启动服务,或者用 make stop 方式关闭服务。

  1. # init nginx config file and etcd
  2. $ make init
  3. # start APISIX server
  4. $ make run
  5. # stop APISIX server
  6. $ make stop
  7. # more actions find by `help`
  8. $ make help
  9. Makefile rules:
  10. help: Show Makefile rules
  11. deps: Installation dependencies
  12. utils: Installation tools
  13. lint: Lint Lua source code
  14. init: Initialize the runtime environment
  15. run: Start the apisix server
  16. stop: Stop the apisix server
  17. verify: Verify the configuration of apisix server
  18. clean: Remove generated files
  19. reload: Reload the apisix server
  20. install: Install the apisix (only for luarocks)
  21. test: Run the test case
  22. license-check: Check Lua source code for Apache License

4. 运行测试案例

  1. 先安装 perl 的包管理器 cpanminus
  2. 然后通过 cpanm 来安装 test-gninx:sudo cpanm --notest Test::Nginx IPC::Run > build.log 2>&1 || (cat build.log && exit 1)
  3. 然后 clone 最新的源码:git clone https://github.com/openresty/test-nginx.git
  4. 通过 perl 的 prove 命令来加载 test-nginx 的库,并运行 /t 目录下的测试案例集:
    • 追加当前目录到perl模块目录: export PERL5LIB=.:$PERL5LIB
    • 直接运行:make test
    • 指定 nginx 二进制路径:TEST_NGINX_BINARY=/usr/local/bin/openresty prove -Itest-nginx/lib -r t

疑难排解测试

配置 Nginx 路径

如果遇到问题 Error unknown directive "lua_package_path" in /API_ASPIX/incubator-apisix/t/servroot/conf/nginx.conf 确保将openresty设置为默认的nginx并按如下所示导出路径。

  • export PATH=/usr/local/openresty/nginx/sbin:$PATH
    • Linux 默认安装路径:
      • export PATH=/usr/local/openresty/nginx/sbin:$PATH
    • OSx 通过homebrew默认安装路径:
      • export PATH=/usr/local/opt/openresty/nginx/sbin:$PATH

运行单个测试用例

  • 使用以下命令运行指定的测试用例:
    • prove -Itest-nginx/lib -r t/plugin/openid-connect.t

5. 更新 Admin API 的 token ,保护 Apache APISIX

修改 conf/config.yaml 中的 apisix.admin_key 并重启服务。例如下面例子:

  1. apisix:
  2. # ... ...
  3. admin_key
  4. -
  5. name: "admin"
  6. key: abcdefghabcdefgh
  7. role: admin

当我们需要访问 Admin API 时,就可以使用上面记录的 key 作为 token 了。

  1. $ curl http://127.0.0.1:9080/apisix/admin/routes?api_key=abcdefghabcdefgh -i
  2. HTTP/1.1 200 OK
  3. Date: Fri, 28 Feb 2020 07:48:04 GMT
  4. Content-Type: text/plain
  5. ... ...
  6. {"node":{...},"action":"get"}
  7. $ curl http://127.0.0.1:9080/apisix/admin/routes?api_key=abcdefghabcdefgh-invalid -i
  8. HTTP/1.1 401 Unauthorized
  9. Date: Fri, 28 Feb 2020 08:17:58 GMT
  10. Content-Type: text/html
  11. ... ...
  12. {"node":{...},"action":"get"}