目录JAVA全系列 教程
3762个小节阅读：7090.5k
目录
C语言快速入门
JAVA全系列 教程
面向对象的程序设计语言
Python全系列 教程
Python3.x版本，未来主流的版本
人工智能 教程
顺势而为，AI创新未来
大厂算法 教程
算法，程序员自我提升必经之路
C++ 教程
一门通用计算机编程语言
微服务 教程
目前业界流行的框架组合
web前端全系列 教程
通向WEB技术世界的钥匙
大数据全系列 教程
站在云端操控万千数据
AIGC全能工具班
A A
White Night
key-auth插件实现了基于 API Key 进行认证鉴权的功能，支持从 HTTP 请求的 URL 参数或者请求头解析 API Key，同时验证该 API Key 是否有权限访问。
全局配置
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
consumers | array of object | 必填 | - | 配置服务的调用者，用于对请求进行认证 |
keys | array of string | 必填 | - | API Key 的来源字段名称，可以是 URL 参数或者 HTTP 请求头名称 |
in_query | bool | in_query 和 in_header 至少有一个为 true | true | 配置 true 时，网关会尝试从 URL 参数中解析 API Key |
in_header | bool | in_query 和 in_header 至少有一个为 true | true | 配置 true 时，网关会尝试从 HTTP 请求头中解析 API Key |
global_auth | bool | 选填 | - | 若配置为true，则全局生效认证机制; 若配置为false，则只对做了配置的域名和路由生效认证机制; 若不配置则仅当没有域名和路由配置时全局生效（兼容机制） |
consumers中每一项的配置字段说明如下：
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
credential | string | 必填 | - | 配置该consumer的访问凭证 |
name | string | 必填 | - | 配置该consumer的名称 |
域名和路由级配置
| 名称 | 数据类型 | 填写要求 | 默认值 | 描述 |
|---|---|---|---|---|
allow | array of string | 必填 | - | 对于符合匹配条件的请求，配置允许访问的consumer名 |
注意：
- 对于通过认证鉴权的请求，请求的header会被添加一个
X-Mse-Consumer字段，用以标识调用者的名称。
1、对特定路由或域名开启
以下配置将对网关特定路由或域名开启 Key Auth 认证和鉴权，注意credential字段不能重复
全局配置
xxxxxxxxxxconsumers:- credential: 2bda943c-ba2b-11ec-ba07-00163e1250b5 name: consumer1- credential: c8c8e9ca-558e-4a2d-bb62-e700dcc40e35 name: consumer2keys:- apikeyin_query: trueglobal_auth: false路由级配置
对 route-a 和 route-b 这两个路由做如下配置：
xxxxxxxxxxallow: - consumer1对 *.exmaple.com 和 test.com 在这两个域名做如下配置:
xxxxxxxxxxallow:- consumer2请求未提供 API Key，返回401
xxxxxxxxxxcurl http://xxx.hello.com/test
| HTTP 状态码 | 出错信息 | 原因说明 |
|---|---|---|
| 401 | No API key found in request | 请求未提供 API Key |
| 401 | Request denied by Key Auth check. Invalid API key | 不允许当前 API Key 访问 |
| 403 | Request denied by Basic Auth check. Unauthorized consumer | 请求的调用方无访问权限 |