kong-plugin-demo

一个简单的 Kong 自定义插件示例，插件执行的逻辑是，读取 X-Request-Base64 请求 header 的字符串参数，然后对这个字符串执行 base64 解码，解码结果通过 header X-Response-Decoded 返回。

安装这个插件，可以参考 Kong 官方文档，支持两种方式。

可以使用 LuaRocks 安装这个插件：

$ git clone https://github.com/yulewei/kong-plugin-demo.git
$ cd kong-plugin-demo
# 构建并安装 rock
$ sudo luarocks make
# 查看安装的 rock
$ luarocks show kong-plugin-demo

或者，不通过 LuaRocks 安装，修改 kong.conf，把这个插件添加到 lua_package_path 路径中。示例如下：

lua_package_path = /home/yulewei/kong-plugin-demo/?.lua;;

安装或者修改路径完成后，再修改 kong.conf 配置文件的 plugins 配置项，让 Kong 加载这个插件 demo：

plugins = bundled,demo

重启 Kong，执行 kong restart 或者 kong prepare && kong reload。如果启动正常，就能通过 Admin API 查看到这个被加载到的插件：

$ curl -s http://localhost:8001/plugins/enabled | grep demo

上面让 Kong 加载到这个插件，但还没有开启，没有真正执行。现在来试下开启这个插件。

通过调用 Kong 提供的 Admin API，让 Kong 创建了名为 example.service 的 service，service 指向的上游服务是 http://httpbin.org。然后，在 example.service 上添加 route，规则是让请求路径前缀为 / 的请求全部转发到这个 service。

# 添加 service
$ curl -XPOST -H 'Content-Type: application/json' \
     -d '{"name":"example.service","url":"http://httpbin.org"}' \
     http://localhost:8001/services/

# 在 service 上添加 route
$ curl -XPOST -H 'Content-Type: application/json' \
     -d '{"paths":["/"],"strip_path":false}' \
     http://localhost:8001/services/example.service/routes

验证接口转发情况：

$ curl -i http://localhost:8000/status/200
HTTP/1.1 200 OK
...
Via: kong/1.5.1

现在在 example.service 这个 service 开启 demo 插件：

# 在 service 上开启 demo 插件
$ curl -XPOST --data "name=demo" \
       http://localhost:8001/services/example.service/plugins

验证插件执行情况：

$ curl -i -H 'X-Request-Base64: aGVsbG8ga29uZw==' http://localhost:8000/status/200
HTTP/1.1 200 OK
...
X-Response-Decoded: hello kong
...
Via: kong/1.5.1

可以看到，请求头的 aGVsbG8ga29uZw==，被成功解码为 hello kong。

参考：

2020-05 微服务 API 网关 Kong 实践 https://nullwy.me/2020/05/kong-gateway/
Plugin Development https://docs.konghq.com/1.5.x/plugin-development/
Kong plugin template https://github.com/Kong/kong-plugin

yulewei / kong-plugin-demo

kong-plugin-demo

About

Languages