YAPI接口自动鉴权功能部署详解

偏执的太偏执、 2024-03-22 23:44 90阅读 0赞

**目录**

安装准备

在线安装

离线安装

配置使用

--------------------

## **安装准备** ##

以下操作，默认要求自己部署过yapi，最好是部署过yapi二次开发环境。

无论是选择在线安装或者是本地安装，都需要安装client工具。

1、yapi-cli：npm install yapi-cli –g，

2、安装后将文件夹nodejs/node\_global配置进环境变量。

3、ykit: npm install -g ykit。

## **在线安装** ##

1、转到含有config.json的目录下

2、执行：yapi plugin --name yapi-plugin-interface-oauth2-token

在线安装一般对网络要求较高，在失败的情况下可以使用离线安装。

## **离线安装** ##

1、下载源码：https://github.com/shouldnotappearcalm/yapi-plugin-interface-oauth2-token

2、`解压源码中的node_modules.tar.gz`，覆盖原来的yapi下`node_modules`目录。

3、转到vendors目录下

4、执行：ykit pack –m

![508d85b350981b264aba641466449373.png][]

5、若碰到以上问题，一般都需要更新node-sass，执行指令：npm rebuild node-sass

![843e489d2f50e63106b49a48a581e7c1.png][]

6、安装完毕，重启yapi服务：

![690d7a841333618256dd1a4eadfc4925.png][]

## **配置使用** ##

1、选择：接口->设置->接口自动授权，**选择已设置的环境**，打开**自动获取token选项**，即打开计划任务：

![2d7389cb3dd3f6ed6aaa5416425d7daa.png][]

2、**获取token地址**：这里就按照一个普通接口去处理，根据不同的调用方式，填写接口名和入参即可。有几点说明：

a、get方法地址后带的参数和下面的参数列表会重复，只需要填一处即可。比如上面地址里含有?username=xxx，下面的列表里就不要再写username这个参数了。

b、“检验”按钮很有用，可用判断是否可通过当前接口取token。如果是普通接口，返回的一般是401（无授权表现），所以要保证该检验通过。

c、“data”表里默认是空白，旁边有个Delete键。如果为空，则可以不管。不用特意按Delete键删除，删除后较难恢复。

![41c53000b3bd0be0d64fe8e9b84ba3c0.png][]

3、**设置token有效时长**：短于token更新时长与token过期时长两者的最小值即可。

4、**请求头字段**：按待测程序，程序的token写在哪里，就设置哪个字段。

5、**获取路径**：F12调试获取token地址，如果返回的是json，那根节点就是body，然后一层层按路径往下取即可。很多情况下路径是这样的：body.result.jwt.token\_type + " " + body.result.jwt.access\_token

6、**保存**：保存按钮其实是可以起到调试作用的。保存后会实时触发一次更新。更新后可以去“环境配置”中查看更新后的值。记得查看前要按F5刷新页面。

![d98d3ebfce2c2ac7ac22899e612a2169.png][]

![17484cd5a7092975998692c290934768.png][]

至此，接口鉴权功能添加完毕。

--------------------

**以下是我收集到的比较好的学习教程资源，虽然不是什么很值钱的东西，如果你刚好需要，可以评论区，留言【777】直接拿走就好了**

![c1653dd19f35495583cef3678b57b6b0.png][]

![775632765b6744fbbecbd8fdd097d1ab.png][]

**各位想获取资料的朋友请****点赞 + 评论 + 收藏****，三连！**

**三连**之后我会在评论区挨个私信发给你们~

[508d85b350981b264aba641466449373.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/87721a092b7b4f56a12c325a7544c676.png
[843e489d2f50e63106b49a48a581e7c1.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/dcdda2da08a54593a686b7a683e3ca42.png
[690d7a841333618256dd1a4eadfc4925.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/369b5720dca84a9c880d8d08f553f985.png
[2d7389cb3dd3f6ed6aaa5416425d7daa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/89ef8c29aef4483484a964ac4770eac8.png
[41c53000b3bd0be0d64fe8e9b84ba3c0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/33d7239ba4d34db18ee36c2dc44e859c.png
[d98d3ebfce2c2ac7ac22899e612a2169.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/b277b57bb7af42ec9c1d12e7be527bd3.png
[17484cd5a7092975998692c290934768.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/cfb724ee2eaf4d1bb1a4f59fc2c4b2c8.png
[c1653dd19f35495583cef3678b57b6b0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/341f737abe514528ad86b5a02f9e3af3.png
[775632765b6744fbbecbd8fdd097d1ab.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/14/7c570d2ed74c43baaf7513213e19de44.png