kong插件之Request Transformer

akio_medue

已于 2024-01-10 11:12:23 修改

阅读量6.3k

点赞数

CC 4.0 BY-SA版权

于 2017-12-22 10:52:16 首次发布

本文链接：https://blog.youkuaiyun.com/qq_26656329/article/details/78870843

API gateway 同时被 2 个专栏收录

14 篇文章

订阅专栏

kong api gateway

14 篇文章

订阅专栏

本文介绍了Kong的Request Transformer插件，该插件能够根据请求头中的参数动态添加或替换请求内容。详细阐述了插件的执行顺序，创建API的步骤，插件关联方法以及参数介绍，并提供了测试修改header的示例和更多使用教程链接。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

说明

插件实现是根据客户端发送的请求头中的参数,通过请求头参数添加或替换参数内容;
插件执行顺序

remove->rename->replace->add->append

创建API

curl -i -X POST \
    --url http://localhost:8001/apis/ \
    --data 'name=example-api' \
    --data 'uris=/user' \
    --data 'upstream_url=http://test.my' \
    --header 'Accept-Charset:GBK'

返回值

{
    "created_at":1513907363000,
    "strip_uri":true,
    "id":"d62dc229-2701-46d7-831e-080906e41a72",
    "name":"example-api",
    "http_if_terminated":false,
    "preserve_host":false,
    "upstream_url":"http://test.my",
    "uris":[
        "/user"
    ],
    "upstream_connect_timeout":60000,
    "upstream_send_timeout":60000,
    "upstream_read_timeout":60000,
    "retries":5,
    "https_only":false
}

关联插件

参数介绍

consumer_id: 可选,消费者id;
config.http_method: 可选,请求方式;
config.remove.headers: 可选,删除header内容;
config.remove.querystring: 可选,删除部分URI;
config.remove.body: 可选,删除(content.request.body)请求体内容,Content-Type为以下(application/json,multipart/form-data,application/x-www-form-urlencoded)才能生效;
config.replace.headers: 可选,替换header;
config.replace.querystring: 可选,替换部分URI;
config.rename.headers: 可选,重命名header;
config.rename.querystring: 可选,重命名部分URI;
config.rename.body: 可选,重命名,参考config.remove.body;
config.replace.body: 可选,替换,参考config.remove.body,
config.add.headers: 可选,添加header内容;
config.add.querystring: 可选,添加部分URI内容;
config.add.body: 可选,添加,参考config.remove.body;
config.append.headers: 可选,追加header内容;
config.append.querystring: 可选,追加部分URI;
config.append.body: 可选,追加,参考config.remove.body;

测试修改header

curl -X POST http://localhost:8001/apis/example-api/plugins \
    --data "name=request-transformer" \
    --data "config.replace.headers='Accept-Charset:UTF-8'"

返回值

{
    "created_at":1513907423000,
    "config":{
        "remove":{
            "querystring":{

            },
            "headers":{

            },
            "body":{

            }
        },
        "replace":{
            "querystring":{

            },
            "headers":[
                "'Accept-Charset:UTF-8'"
            ],
            "body":{

            }
        },
        "append":{
            "querystring":{

            },
            "headers":{

            },
            "body":{

            }
        },
        "add":{
            "querystring":{

            },
            "headers":{

            },
            "body":{

            }
        },
        "rename":{
            "querystring":{

            },
            "headers":{

            },
            "body":{

            }
        }
    },
    "id":"e4b3eb72-9fab-4736-bbdd-22709e788367",
    "name":"request-transformer",
    "api_id":"d62dc229-2701-46d7-831e-080906e41a72",
    "enabled":true
}

更多使用方法参考教程文档