共计 1161 个字符,预计需要花费 3 分钟才能阅读完成。
1、前景回顾
在【API 网关 Kong 系列三】– 战前预热 中已经对 Consumer 的做了介绍,在这我们在来回顾下。
Consumer 对象表示服务的使用者或者用户。您可以依靠 Kong 作为主数据库存储,也可以将使用者列表与数据库映射,以保持 Kong 与现有的主数据存储之间的一致性。
本章我们来主要介绍 Consumer 的 API
2、创建一个 Consumer
下面我们来用 cUrl 方式来做一个创建 Consumer 的示例。
$ curl -i -X POST \
--url http://localhost:8001/consumers/ \
--data "username=Jason"
响应如下
HTTP/1.1 201 Created
Content-Type: application/json
Connection: keep-alive
{
"username": "Jason",
"created_at": 1428555626000,
"id": "bbdf1c48-19dc-4ab7-cae0-ff4f59d87dc9"
}
在这一个简单的 Consumer 就创建完成了,是不是很简单。接着我们来了解下 Consumer 的其它 PAI
3、Consumer API
3.1.1 添加 Consumer
请求地址 | /consumers |
请求方式 | POST |
参数 | |
username(可选) | 消费者的唯一名称,和 custom_id 有且最少有一个 |
custom_id(可选) | 用于存储消费之的的唯一 id, 对于和数据库中的用户进行映射非常有用,和 username 有且最少有一个 |
tags(可选) | 与 consumer 关联的一组 tags,用于分组和过滤 |
3.1.2 查询 Consermer
请求地址 | /consumers/{username or id} |
请求方式 | GET |
参数 | |
username or id | 需要检索 consumer 的 username or id |
3.1.3 查询和特定插件关联的 Consumer
请求地址 | /plugins/{plugin id}/consumer |
请求方式 | GET |
参数 | |
plugin id | 与要检索的 Consumer 关联的插件的 id |
3.1.4 更新 Consumer
请求地址 | /consumers/{username or id} |
请求方式 | PATCH |
参数 | |
username or id | 要更新 Consumer 的 id 或者 username |
3.1.5 删除 Consumer
请求地址 | /consumers/{username or id} |
请求方式 | DELETE |
参数 | |
username or id | 要删除的 Consumer 的 id 或者 username |
4、总结
本章主要介绍了 Consumer 的 api、从介绍上来看 Consumre 的使用非常简单,其主要适合一个插件配合使用,在以后的章节会介绍道,在这我们只是先了解下有个印象。
想了解更多关于 Kong 网关的请移步 >>>>> 企业级 API 网关 Kong
正文完