YAPI可视化接口管理服务部署

Petrochor

发布于 2022-06-07 16:01:27

5250

发布于 2022-06-07 16:01:27

文章被收录于专栏：Stephen

YAPI是一个高效、易用、功能强大的API管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务，可以帮助开发者轻松创建、发布、维护 API。支持数据导入导出、可视化接口管理、自动化测试、Mock Server、权限管理以及强大的插件等。

环境要求

nodejs（v7.6+，建议选择 v12 以下版本）
mongodb（v2.6+）

Mongo

YAPI依赖于MongoDB

docker run --name mongo -v /usr/local/mongo/data:/data -d -it -p 27017:27017 mongo:5.0

YAPI

可视化部署[推荐]

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

npm install -g yapi-cli --registry https://registry.npm.taobao.org
# 将开启9000端口，可视化部署YAPI
yapi server
# 后台启动YAPI
nohup node vendors/server/app.js  >/dev/null 2>&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配置的端口}，初次运行会有个编译的过程，请耐心等候

本文参与腾讯云自媒体同步曝光计划，分享自作者个人站点/博客。

原始发表：2021/08/18 ，如有侵权请联系 cloudcommunity@tencent.com 删除

api