basic-auth

    该插件需要与 一起使用。API 的消费者可以将它们的密钥添加到请求头中以验证其请求。

    Consumer 端：

    Route 端：

    名称类型必选项默认值描述
    hide_credentialsboolean否false该参数设置为 true 时，则会将 Authorization 请求头传递给 Upstream。

    你也可以通过 APISIX Dashboard 完成上述操作。

    创建 Consumer 后，就可以通过配置 Route 或 Service 来验证插件，以下是配置 Route 的命令：

    1. curl http://127.0.0.1:9180/apisix/admin/routes/1 \
    2. -H 'X-API-KEY: edd1c9f034335f136f87ad84b625c8f1' -X PUT -d '
    3. {
    4.     "uri": "/hello",
    6.         "basic-auth": {}
    7.     },
    8.     "upstream": {
    9.         "type": "roundrobin",
    10.         "nodes": {
    11.             "127.0.0.1:8080": 1
    13. }'

    通过上述命令启用插件后，可以通过以下方法测试插件。

    1. HTTP/1.1 200 OK
    2. ...
    3. hello, world

    如果请求未授权，则返回如下结果：

    如果用户名和密码错则返回如下结果：

    1. HTTP/1.1 401 Unauthorized
    2. ...
    3. {"message":"Invalid user authorization"}

    当你需要禁用 插件时，可以通过以下命令删除相应的 JSON 配置，APISIX 将会自动重新加载相关配置，无需重启服务：