swagger管理接口时ui交互做的不太友好,信息展示的不够明确,接口分类也做的不是很好,所以打算使用YApi+swagger的形式进行统筹前后端接口。
1.下载
从国内gitee
急速下载Yapi
2.安装
前置环境:node.js、[mongoDb](https://blog.csdn.net/qq_34870166/article/details/111030588)
使用的visual studio code
工具,打开Yapi解压后的文件夹建立新终端,依次
输入以下两
个命令
npm install -g yapi-cli --registry https://registry.npm.taobao.orgyapi server
执行安装后会出现一个地址+端口,在网页上登录上去,会出现下面这个页面,数据库地址端口输入mongoDB的,部署路径
记录起来。输入完毕点击开始部署
部署需要几分钟时间,期间会出现警告,若无影响可以无视,部署完毕以后会有后台地址、账号密码记录起来
使用的visual studio code
工具,打开部署的路径,找到my-api
文件夹,并打开他。在命令行输入node vendors/server/app.js
,出现下面的结果就说明部署成功
进入提示的页面,输入之前设置的账号密码进入到yapi的控制台
导入操作按照以下进行操作
接口地址在swagger页面上能看的见
确定导入后完成,效果如下。
需要严格规范开发人员的编码习惯,毕竟好东西都是人用出来的。