APISIX、APISIX Dashboard搭建、路由配置及插件使用

本文简要描述了APISIX、APISIX Dashboard的搭建

docker部署见"快速部署"部分,这里主要记录关键信息和插件部分

以及消费者consumer、插件等的使用

目录

部署

官方文档

官方文档中文

快速部署

github

gitee

APISIX Dashboard

配置文件位置

账号密码

APISIX Dashboard使用

路由配置

填写路由规则 

配置上游服务

插件使用

basic-auth

创建消费者

启用basic-auth

key-auth

 创建消费者

配置路由并启用key-auth

API中使用


部署

官方文档

https://apisix.apache.org/zh/docs/apisix/getting-started

官方文档中文

Apache APISIX - 《Apache APISIX v2.6 官方文档》 - 书栈网 · BookStack

快速部署

官方git开源项目下有中文说明,可以通过docker等形式快速启动apisix及dashboard,还带中文版的说明。

github

​​​​​​https://github.com/apache/apisix/blob/master/docs/zh/latest/getting-started.mdhttps://github.com/apache/apisix/blob/master/docs/zh/latest/getting-started.md

gitee

docs/zh/latest/getting-started.md · Gitee 极速下载/apisix - Gitee.comhttps://gitee.com/mirrors/apisix/blob/master/docs/zh/latest/getting-started.md

根据以上文档直接clone项目到服务器,通过docker或者docker-compose启动即可(记得确认端口号)

参考文档,gitee极速下载,克隆项目(此版本下有中文说明) clone https://gitee.com/mirrors/apisix

参考此说明部署:

docs/zh/latest/getting-started.md

APISIX Dashboard

已在上一部中同时被启动

配置文件位置

example/dashboard_conf/conf.yaml

账号密码

在上述配置文件中

users:                # yamllint enable rule:comments-indentation
  - username: admin   # username and password for login `manager api`
    password: ******xxxx
  - username: user
    password: ******xxx

APISIX Dashboard使用

主要通过APISIX Dashboard

以下填写的域名,需要解析到APISIX服务器,APISIX端口最好映射80、443

路由配置

填写路由规则 

填完上述信息点下一步

配置上游服务

不使用插件的情况下,下一步,下一步完成 即可。

插件使用

basic-auth

:适用于简单的登录校验

:basic-auth 是一个认证插件,它需要与 consumer 一起配合才能工作。

添加 Basic Authentication 到一个 service 或 route。 然后 consumer 将其用户名和密码添加到请求头中以验证其请求。

创建消费者

consumer

 填写消费者名称及描述,点下一步

进入插件页面,启用basic-auth

 输入用户名密码,启用插件,提交

 点下一步预览,提交即可。

启用basic-auth

在需要启用登录认证的路由配置时启用basic-auth插件即可

 

 这样打开此路由时就需要输入用户名密码校验了

其他很多插件也是依赖消费者basic-auth的,使用方式雷同,待后续补充 。

key-auth

key-auth | Apache APISIX® -- Cloud-Native API Gateway

The key-auth Plugin is used to add an authentication key (API key) to a Route or a Service.

This works well with a Consumer. Consumers of the API can then add their key to the query string or the header to authenticate their requests.

key-auth 插件用于向 Route 或 Service 添加身份验证密钥(API 密钥)。 这适用于消费者。然后,API 的使用者可以将他们的密钥添加到查询字符串或标头中以验证他们的请求。

 创建消费者

consumer

填写消费者名称及描述,点下一步

启用key-auth

输入密钥

{
  "disable": false,
  "key": "qu38uhiauth7j&84"
}

 提交,下一步,提交,ok配置消费者完成

配置路由并启用key-auth

这里无需填写内容 

点击启动按钮,下边文字不用输入,会自动生成

 

提交,下一步,提交,ok

API中使用

在param或者header里增加

apikey=qu38uhiauth7j&84即可

成功返回如下:

否则未检测到正确的apikey时网关返回401

  • 3
    点赞
  • 33
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值