YAPI解决接口鉴权的方案

推广文

YApi

YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台,截止 2020-3-7 日,YApi 已经有了 14KStar
使用人数也比较多,功能比较齐全,但是有个问题就在于我们使用 YApi 平台运行我们的测试用例比较麻烦,前后端项目分离的情况下,我们的身份鉴权大多已经是使用令牌的方式来实现用户的鉴权,如果我们手动为每个环境在每次运行测试用例之前手动配置一个令牌,这未免也太影响效率,并且会影响持续集成等工具定时执行测试用例。

鉴权插件的引入

有了上面的问题描述,我们急需要一个东西,他可以帮我们自动填充令牌值到每个请求中,来帮助我们在令牌有效期即将到来之前帮助我们刷新这个令牌,我们这个鉴权插件主要是用来解决什么问题:

  • 配置获取令牌的请求路径和参数,支持 GETPOST 等请求方式
  • 多环境支持,每个环境可以配置不同的令牌获取请求
  • 支持拼接请求返回结果作为令牌,可以获取请求 bodyheader和返回数据以及字符串等作为拼接
  • 支持保存到自定义的请求头,即你可以把获取到的令牌保存到任意 Header 字段中,比如 Authorization
  • 支持设置令牌的有效时间,过了有效时间会自动刷新令牌值,支持到分钟级的配置

安装使用

需要先安装 ykityapi-cli

npm install yapi-cli -g

yapi plugin --name yapi-plugin-interface-oauth2-token

配置使用

配置使用如下图,更多请见 链接

在这里插入图片描述## 成功获取后的结果

在这里插入图片描述更多使用请参见 https://github.com/shouldnotappearcalm/yapi-plugin-interface-oauth2-token

项目链接

欢迎提 Issue, 您的 Issue 是我前进的动力。

欢迎 Star,您的 Star 是我前进的动力。

  • 1
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 4
    评论
感谢您的提问,以下是Yapi接口文档和部署笔记: ## Yapi接口文档 Yapi是一个开源的、高效的、易用的接口管理平台,可以帮助团队更好地协作开发、测试和部署。它提供了丰富的接口管理、文档生成和Mock数据等功能,可以大大提升团队的开发效率和项目质量。 Yapi支持多种类型的接口,包括RESTful API、GraphQL API、RPC API等,可以满足不同的业务需求。同时,Yapi还支持多人协作、权限管理、版本控制等功能,可以让团队更加高效地进行接口开发和测试。 在使用Yapi时,您可以通过创建项目、添加接口、编写文档、生成Mock数据等方式来管理接口。Yapi还提供了丰富的插件和扩展,可以让您更加灵活地使用和定制Yapi。 ## Yapi部署笔记 Yapi的部署比较简单,您只需要按照以下步骤即可完成: 1. 安装Node.js和MongoDB Yapi是基于Node.js和MongoDB开发的,因此您需要先安装它们。您可以到官网下载Node.js和MongoDB的安装包,并按照官方文档进行安装。 2. 下载Yapi源码 您可以从Yapi的官方Github仓库中下载源码: ``` git clone https://github.com/YMFE/yapi.git vendors/yapi ``` 3. 安装依赖 进入Yapi的源码目录,执行以下命令安装依赖: ``` cd vendors/yapi npm install --production ``` 4. 配置Yapi 在Yapi的源码目录中,有一个`config.json`文件,它包含了Yapi的各种配置信息,您可以根据自己的需求进行修改。其中,重要的配置项包括: ``` { "port": "3000", // Yapi服务的端口号 "adminAccount": { // 管理员账号信息 "username": "admin", "password": "ymfe.org" }, "db": { // MongoDB的配置信息 "servername": "127.0.0.1", "port": 27017, "DATABASE": "yapi" } } ``` 5. 启动Yapi 在Yapi的源码目录中,执行以下命令启动Yapi: ``` node server/app.js ``` 然后,您就可以在浏览器中访问`http://localhost:3000`来使用Yapi了。 以上就是Yapi的简单部署笔记,希望对您有所帮助。如果您想了解更多关于Yapi的内容,可以参考官方文档:https://hellosean1025.github.io/yapi/。
评论 4
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

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

抵扣说明:

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

余额充值