YApi安装

一、YApi安装

• YApi官方地址：https://github.com/YMFE/yapi
• YApi-Docker：https://github.com/Ryan-Miao/docker-yapi

1 - 初始化db, 开启自定义配置

• 查看docker的运行情况：docker ps -a，确保docker是开启的
• clone-docker-yapi：git clone https://github.com/Ryan-Miao/docker-yapi.git
  
• 进入docker-yapi目录：cd docker-yapi
• 执行命令：docker-compose up，（运行docker-compose命令会对应目录下的docker-compose.yml文件来生成），这个过程会花一些时间，耐心等待完成
  
• 这里发现一直卡在这，我们需要进行如下处理
  • 路径：vim docker-compose.yml
  • 去掉注释#号 command: “yapi server”，
  • 加注释command: “node /my-yapi/vendors/server/app.js” 这个前面加#号
  • 再去执行：docker-compose up
    
• 重新运行后看到在浏览器打开这个提示，此时我们可以另外打开一个窗口，查看docker的运行情况
  
• 可以到yapi和mongo都已经up了
  

2 - 根据自己的ip地址访问yapi的配置页

• 查看linux的IP地址：
  
• 使用Chrome打开地址：http://192.168.124.51:9090/；注意这个地址需要根据自己的ip地址进行修改
• 按如下配置进行配置

• 开始部署：点击开始部署，等待一会后，出现如下页面代表部署完成
  

3 - 配置修改

• 将之前的yapi server注释打开，并关闭 app.js的注释：修改保存退出后，重新docker-compose up
  
  

4 - 访问ip:3000

• 登录yapi：用户名是上面填写的管理员用户 admin@admin.com 默认密码是 ymfe.org
  

---

二、YApi基本使用

1 - 新建项目

2 - 添加分类

• 预览
  

3 - 运行下的YApi跨域插件安装

• 跳转地址：https://juejin.cn/post/6844904057707085832
• 插件下载地址：https://github.com/YMFE/cross-request/archive/master.zip
• 打开 chrome://extensions：开启开发者模式
  
• 将之前下载的zip解压出来，然后点击打包扩展程序：选择zip解压后的文件路径，打包扩展程序，然后就可以在之前的目录下看到rtx文件
  
  
• 点击加载已加压的扩展程序：选中到解压的最后一层目录（非rtx目录，是下一层目录），即可
  
  
• 刷新运行页面，就可以看到没有之前要安装插件的提示了
  

4 - 设置开启mock严格检查和json5

5 - 编辑 -> 请求参数设置

• 接口 -> 编辑
  
  

6 - 编辑 -> 返回约束

7 - 运行 -> 环境配置

8 - 接口的导入与导出