API KEY

功能描述

鉴权方式的一种,多用于OpenAPI,设置Apikey参数,不能通过认证的用户将无权访问接口。

配置示例

1、新增全局鉴权插件,若该全局插件已存在,可跳过该步骤

2、新建鉴权,Driver选项选择apikey,界面会自动渲染

3、编辑鉴权信息,可添加多个apikey

字段描述说明

字段描述
是否隐藏证书网关转发时是否将Authorization字段删除
密钥apikey的值
用户标签apikey被命中时,会将相关标签带入请求的过程中,如:在access日志中打印相关内容
过期时间apikey有效期,不填则为不过期

4、绑定上游服务/路由,此处示例以绑定上游服务为例,凡匹配到该上游服务的请求都需要进行鉴权

5、路由绑定服务,教程跳转

6、请求接口,并带上以下头部信息

Header描述值可能性
Authorization-Type声明待校验的鉴权类型apikey、apikeyauth、apikey-auth、apikey_auth
Authorization配置的apikey的值

成功访问示例:

curl -H "Authorization-Type: apikey" -H "Authorization: apinto" http://127.0.0.1:8099/apinto/demo

成功返回结果:

失败访问示例:

curl -H "Authorization-Type: apikey" -H "Authorization: test" http://127.0.0.1:8099/apinto/demo

失败返回示例: