目录
[安装 y-api](#安装 y-api)
[启动 y-api](#启动 y-api)
前言
前后端分离时代，前后端通过接口文档来协作开发项目。一般开发过程中，由后端先编写接口文档，然后交付给前端，这时候前后端都根据这个编写的接口文档来进行开发。在没有一个统一的接口管理平台下，仅用一个文档作为前后端团队协作的媒介，一旦出现需求变更或者开发过程发现接口设计不合理需要重新调整，就需要改动接口文档，每次改动需要重新发一个文档给前端，改动次数越多，就会造成文档越混乱，同时也会出现前端对着旧版的接口文档开发的情况。
针对以上问题，可以使用 y-api 接口管理平台来管理，前后端不直接对接，而是通过接口管理平台来沟通。后端在平台写接口文档，前端在平台看接口文档，后端对接口文档的每次调整，前端都能够及时看到，确保了前后端看的接口都是同一份版本。可以减少前后端沟通的成本，有效提高开发效率。
前置环境
mongodb
如果没有安装mongodb，可参考：
https://blog.csdn.net/typeracer/article/details/137157993?spm=1001.2014.3001.5501若已经安装，则启动 mongodb 服务
node
下载 node 包，这里指定版本 12.12.0，其他版本可能会出现问题
进入 /usr/local/ 目录
bash
cd /usr/local下载 node 12 的包
bash
wget https://npm.taobao.org/mirrors/node/v12.12.0/node-v12.12.0-linux-x64.tar.xz解压
bash
tar -xvf node-v12.12.0-linux-x64.tar.xz创建软链接，这样在任意目录便能够使用以下命令
bash
ln -s -f /usr/local/node-v12.12.0-linux-x64/bin/node /usr/local/bin/node
ln -s -f /usr/local/node-v12.12.0-linux-x64/bin/npm /usr/local/bin/npm
ln -s -f /usr/local/node-v12.12.0-linux-x64/bin/npx /usr/local/bin/npx安装 y-api
安装 yapi-cli
bash
npm install -g yapi-cli --registry https://registry.npmmirror.com
进入 bin 文件，执行 yapi server
bash
cd bin
./yapi server
部署页面
浏览器访问服务器 9090 端口
自定义配置，这里选了最新的部署版本
注意：原域名 https://registry.npm.taobao.org 在 2022.06.30 号正式下线和停止 DNS 解析
所以部署会出现以下错误
新的淘宝镜像域名为 https://registry.npmmirror.com
需要修改安装目录下 lib/node_modules/yapi-cli/src/commands/install.js 文件
将其中的 https://registry.npm.taobao.org 换成 https://registry.npmmirror.com
然后重启 yapi server，再次部署，就能够正常下载依赖，最后成功部署
启动 y-api
进入 my-yapi 目录，执行 node vendors/server/app.js
bash
cd my-yapi
node vendors/server/app.js
访问
基本使用教程
添加项目
添加接口
编辑接口
分组权限
