Windows环境Yapi部署及使用

文档整理不易,赏个积分下载一下,资源内容包含以下

Windows环境Yapi部署及使用
Centos7环境Yapi部署
Yapi使用-HAR导入接口

下载地址:

接口文档工具Yapi从0到1搭建使用文档及用法-其它文档类资源-CSDN下载

安装环境

  • nodejs(7.6+)
  • mongodb(2.6+)

nodejs安装,推荐使用nvm安装

  • Nodejs 版本12.10.0,比较新版本安装后,不能使用Yapi

nvm安装

Releases · coreybutler/nvm-windows

安装nvm前注意

  • nvm安装到了有空格的路径上(D:\Program Files),会导致切换版本失败
  • 打开CMD 或 powerShell 时,要以管理员运行(出现问题nvm use 出现exit status 1:乱码 )

在CMD环境下,操作以下功能

node安装时可能比较慢,可以使用淘宝影像


nvm node_mirror https://npm.taobao.org/mirrors/node/

nvm npm_mirror https://npm.taobao.org/mirrors/npm/

安装node


nvm install 12.10.0

查看已安装的node版本列表


nvm ls #或者nvm list

使用node版本


nvm use 12.10.0

卸载node版本


nvm uninstall 12.10.0

MongoDb安装

官方下载:https://www.mongodb.com/try/download/community

安装前注意,要选择Custom,去掉安装Compass,否则安装会很卡

启动mongodb,切换mongodb的bin目录下,d:\data\db 为数据库目录


.\mongod.exe -dbpath d:\data\db

.\mongo.exe

安装Yapi

官方文档:https://hellosean1025.github.io/yapi/devops/index.html

D盘新建目录Yapi,CMD执行以下


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

yapi server

访问 http://127.0.0.1:9090,填写公司名称,开始部署

部署完成后,切换到生成好的my-yapi目录,执行


node vendors/server/app.js

访问: http://127.0.0.1:3000,默认账号: 管理员邮箱,密码ymfe.org

Yapi使用

使用参考文档

https://hellosean1025.github.io/yapi/documents/index.html

我的Yapi使用经验

注册账号,Username不是登录名,Email是登录名

设置全局环境,Header

备份项目时,可以导出json,在新的环境中导入json。导出的html可以放到项目源码中

请求接口,不可发送,按提示文档,安装cross-request插件

返回的Json数据,导入Json,填写字段备注

用上面的方式填写返回数据,无法显示返回数据示例。可以写到富文本中

上一篇:KOA基础使用


下一篇:koa-cookie