当前位置：首页 > article >正文

本地安装YAPI

article 2024/11/24 9:01:23

项目中用到很多的RESTAPI，光靠人工管理或者普通文档肯定是不行的，翻了很多的RESTAPI管理工具，还是选择了YAPI，原因有2，一个是接口位于内网，外网网站上管理测试不到内网接口，另外一个是使用方式，YAPI里的布局，个人感觉更容易理解上手

找了太比较老的Centos7，因为不是新的，所以安装过程中，需要反复调整版本，包括node的版本，和YAPI的版本，版本高了缺组件，要额外安装，版本低了有事后不适配，所以装了四五次不同的版本来适配，最后成功了
下面是要用到的网址

YApi - 接口管理平台
安装手册
使用手册
代码库

1、安装

1.1 安装的前提条件

nodejs（7.6+)
mongodb（2.6+）

Mongodb没啥讲的，node7.6太低了，node不同版本在安装YAPI时会有不同的反应，常见的是缺包，反复几次，后来装了V12.12.12，太高了不行，太低了也不行，YAPI装了1.10.2版本

不同node的下载地址

Node下载：https://nodejs.org/dist/v12.22.12/

node安装方法

下载node-v12.22.12-linux-x64.tar.gz

tar -zxvf node-v12.22.12-linux-x64.tar.gz

修改/etc/profile，最后增加以下两句

export NODEJS_HOME=/usr/local/nodejs
export PATH=$PATH:$NODEJS_HOME/bin

source /etc/profile，让其生效
然后试一下，是不是好了

node -v

如果看到版本号就生效了。

1.2 YAPI安装

方式一. 可视化部署[推荐]

执行 yapi server 启动可视化部署程序，输入相应的配置和点击开始部署，就能完成整个网站的部署。部署完成之后，可按照提示信息，执行 node/{网站路径/server/app.js} 启动服务器。在浏览器打开指定url, 点击登录输入您刚才设置的管理员邮箱，默认密码(ymfe.org) 登录系统（默认密码可在个人中心修改）。

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

执行完后会给你个网址，上去后，可以在网址里填写信息，然后就让网站触发安装
在这里插入图片描述

注意：淘宝的这个仓库过期了，会报错，要改到新仓库https://registry.npmmirror.com
npm install --production --registry https://registry.npmmirror.com

因为我们与github代码库网络不通，因为是外国，网络不联通，所以只能采用方式二

方式二. 命令行部署
如果 github 压缩文件无法下载，或需要部署到一些特殊的服务器，可尝试此方法

mkdir yapi
cd yapi
git clone https://github.com/YMFE/yapi.git vendors //或者下载 zip 包解压到 vendors 目录（clone 整个仓库大概 140+ M，可以通过 `git clone --depth=1 https://github.com/YMFE/yapi.git vendors` 命令减少，大概 10+ M）
cp vendors/config_example.json ./config.json //复制完成后请修改相关配置
cd vendors
npm install --production --registry https://registry.npmmirror.com
npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
node server/app.js //启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候