小记,公司需要,在公司的服务器部署一个开源的可视化接口管理平台

Yapi官方网址

https://github.com/ymfe/yapi

image-1676267691357

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

拉取仓库代码&运行项目

代码拉取

git clone https://github.com/YMFE/yapi.git

安装相关的依赖

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

运行Yapi程序,端口默认是9090

yapi server

image-1676267977043

初始化配置

填写相关的信息,然后开始部署

image-1676268598269

image-1676269902594

登录注册

部署完成之后,就可以注册或者是登录管理相关的接口文档了

image-1676271819198

mongodb数据库的安装部署

因为yapi使用的是mongodb数据库,所以没有安装的话需要安装

下载mongodb安装包
https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-4.0.18.tgz

也可以去官网下载其他版本
https://www.mongodb.com/download-center/community

解压
tar -zxvf mongodb-linux-x86_64-4.0.18.tgz 
配置环境变量
vi /etc/profile

在文件的最下面添加

export PATH=$PATH:/usr/local/mongodb/bin
创建文件夹

一个存放数据,一个存放日志

mkdir -p /data/db
mkdir -p /logs
创建配置文件
cd /usr/local/mongodb/bin
touch mongodb.conf
vim mongodb.conf
修改配置文件内容
dbpath = /data/db # 数据文件存放目录
logpath = /logs/mongodb.log # 日志文件存放目录
port = 27017 # 端口
fork = true # 以守护程序的方式启用,即在后台运行
noauth = true # 不进行安全验证
# auth=true 
# 需要认证。如果放开注释,就必须创建MongoDB的账号,使用账号与密码才可远程访问,第一次安装建议注释
bind_ip=0.0.0.0 # 允许远程访问,或者直接注释,127.0.0.1是只允许本地访问
启动mongodb
./mongod -f mongodb.conf