前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Yapi 部署二次开发常见问题

Yapi 部署二次开发常见问题

作者头像
公号:咻咻ing
发布2019-09-30 14:26:48
3K0
发布2019-09-30 14:26:48
举报
文章被收录于专栏:公众号:咻咻ing公众号:咻咻ing

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

1、命令行部署

如果 github 压缩文件无法下载,或需要部署到一些特殊的服务器,可尝试此方法

代码语言:javascript
复制
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配置的端口},初次运行会有个编译的过程,请耐心等候

安装后的目录结构如下:

代码语言:javascript
复制
|-- 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中的authpass配置。

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,一天同步一次。

本文参与 腾讯云自媒体分享计划,分享自微信公众号。
原始发表:2019-09-27,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 咻咻ing 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 1、命令行部署
  • 常见问题
相关产品与服务
云数据库 MongoDB
腾讯云数据库 MongoDB(TencentDB for MongoDB)是腾讯云基于全球广受欢迎的 MongoDB 打造的高性能 NoSQL 数据库,100%完全兼容 MongoDB 协议,支持跨文档事务,提供稳定丰富的监控管理,弹性可扩展、自动容灾,适用于文档型数据库场景,您无需自建灾备体系及控制管理系统。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档