接口文档—Yapi

709 阅读2分钟

什么是 Yapi

YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台。YApi兼具swaggerrap2postman 的各项优点.

YApi 是支持本地化部署的接口管理平台

YApi 的功能特性

  • 可视化接口管理
  • 数据mock
  • 自动化接口测试
  • 数据导入(各种,包括swagger、har、postman、json、命令行)
  • 权限管理
  • 支持本地化部署
  • 支持插件
  • 支持二次开发

Yapi 部署需要的相关环境

  1. 确保 node 版本 ≥ 7.6,请运行 node -v 查看版本号
  2. 确保 mongodb 版本 ≥ 2.6,请运行 mongo --version 查看版本号
  3. 确保安装了 npm, 运行 npm -v 查看版本号
  4. 确保安装了 git,运行 git --version 查看版本号
  5. 确保安装了 node-gyp 环境,配置方法

Yapi 内网部署出现问题请看这里 https://github.com/YMFE/yapi/issues/16

命令行启动:

npm install -g yapi-cli --registry https://registry.npm.taobao.org

yapi server 启动默认访问的地址是 http://0.0.0.0:9090

但是打开的页面是无法访问的,这里需要将 域名改成 localhost:9090 后则正常显示:

image.png

安装 MongoDB

MongoDB 下载地址 <https://www.mongodb.com/download-center/community>

MongoDB 将数据目录存储在 db 目录下。但是这个数据目录不会主动创建,我们在安装完成后需要创建它。请注意,数据目录应该放在根目录下: 比如我这里安装在 D:\Software\MongoDB 文件下,则在 D: 下创建一个 data 的目录,然后在 data 文件里创建 db 文件。

命令行下运行 MongoDB 服务器

从 MongoDB 目录的 bin 目录中执行 mongod.exe 文件

  `D:\Software\MongoDB\bin>mongod --dbpath D:\data\db`

如果执行成功,会输出如下信息:

f9cae6f1d49439f1cad449fa2af0c81.jpg

连接MongoDB

我们可以在另起一个命令窗口中运行 mongo.exe 命令即可连接上 MongoDB,执行如下命令:

D:\Software\MongoDB\bin\mongo.exe

bee387d7683f1d5232cc2eac60fb3bd.jpg

Yapi平台部署 点击开始部署后出错问题

3cc133acfdb1c34480ce5fe870907c2.jpg image.png 解决方法: 部署版本- 选择1.8.8

依赖安装成功,但还显示有个错误: image.png

cd 至 my-yapi 文件下 执行命令 node vendors/server/app.js

image.png

访问 http://127.0.0.1:3000/ 能正常登录,貌似上面一个错误不影响使用。默认账号:admin@admin.com 密码:ymfe.org

image.png

可视化接口管理

image.png image.png

数据导入

从一个网站下载一批接口:

image.png

文件导入:

image.png

数据mock

mock请求参数和返回数据

  • 模拟登录接口 image.png
  • 添加请求参数

image.png

  • 返回数据设置 image.png

预览及环境设置

image.png image.png 1664591259978.jpg

发送请求

需要安装浏览器插件: # chrome 安装 yapi 扩展教程

image.png

这样在本地开发过程中就可以利用 Yapi 进行接口模拟并请求数据了。