Yapi 部署二次开发常见问题

• 2019 年 10 月 11 日
• 筆記

Yapi 作为目前业内最好用的接口管理平台， 旨在为开发、产品、测试人员提供更优雅的接口管理服务，可以帮助开发者轻松创建、发布、维护 API。

1、命令行部署

如果 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.npm.taobao.org  npm run install-server //安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置  node server/app.js //启动服务器后，请访问 127.0.0.1:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候  

安装后的目录结构如下：

|-- config.json  |-- init.lock  |-- log  `-- vendors      |-- CHANGELOG.md      |-- LICENSE      |-- README.md      |-- client      |-- common      |-- config_example.json      |-- doc      |-- exts      |-- nodemon.json      |-- npm-debug.log      |-- package.json      |-- plugin.json      |-- server      |-- static      |-- test      |-- webpack.alias.js      |-- yapi-base-flow.jpg      |-- ydocfile.js      `-- ykit.config.js  

说明：

1、如果MongoDB没有设置密码可以删除config.json中的auth和pass配置。

2、初始化完成后会生成init.lock文件，如果需要重新初始化，可以删除此文件。

常见问题

1、MongoDB连接失败

错误信息：MongoError: failed to connect to server [192.168.10.5:27017] on first connect

MongoDB服务没起，或者config.json中参数配置不正确

2、初始化失败

错误信息：UnhandledPromiseRejectionWarning: Error: 初始化管理员账号

init.lock文件被删除了，导致yapi再初始化时DB中已经存在这个账户信息，所有报错，可以把DB中该账户信息删除，或者修改配置文件中的初始账号。

3、ykit 打包命令找不到

npm install ykit -g安装ykit命令

4、ydoc 构建文档命令找不到

npm install -g ydoc 安装ydoc命令 执行 ydoc build 重新构建生成文档

5、不支持long类型数据

默认的js不支持long类型，导致传入long类型时可能导致接口错误。

6、Yapi项目拉取失败

可以使用国内镜像地址：https://gitee.com/mirrors/YApi.git，一天同步一次。