一个把 url query 查询参数修改为 json 参数的简单 kong 插件。
A plugin that converts parameters to json.

说明

  • 名称：query-string-to-json
  • 地址：https://github.com/qianyugang/kong-query-string-to-json
  • 说明：本插件主要作用是把url中的查询参数转换为特定参数的json字符串params={}并替换到原url中。

  • 例如：原有url为

    1
    2
    3
    4
    5
    http://service-host.com?minitest?appkey=xxx&size=10&qq=11&ww=22
    经过kong代理，并使用本插件之后，请求会变为:		
      
    http://kong.com:8000?appkey=xxx&size=10&params={"qq":"11","ww":"22"}

  • 参数：

    • 配置参数中exclude_params_names为不需要转换为json的参数。例如上例中的appkey和size参数，就没有转换为json。
    • 配置参数中params_name为json之后的query参数key，默认为params。

使用

在配置完成 service 以及 route 代理之后，可以添加本插件到需要的 service 或者 route 上，例如：

1
2
3
curl -X POST http://192.168.1.5:8001/routes/1ed4443c-e677-4af4-b551-ad6fd99a55e1/plugins\
    --data "name=kong-query-string-to-json"  \
    --data "config.exclude_params_names[]=size&config.exclude_params_names[]=appkey"

版本兼容

1
kong >= 2.0.0