如何在Ubuntu系统上安装YApi

news2025/6/9 23:08:54

简单介绍
1. YApi是高效、易用、功能强大的api管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护API，YApi还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。
2. 官网信息
  1. 源代码仓库：YMFE/yapi: YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台 (github.com)
  2. 官方文档链接：YApi 接口管理平台 (hellosean1025.github.io)
YApi的内网部署的环境要求
1. nodejs（7.6+)
2. mongodb（2.6+）
3. git

克隆仓库代码并初始化部署

# 创建yapi文件夹
mkdir yapi
cd yapi
# 克隆仓库代码
git clone --depth=1 https://github.com/YMFE/yapi.git vendors
# 复制yapi配置文件，拷贝完成后请根据需求修改相关配置
cp vendors/config_example.json ./config.json 
cd vendors

设置NodeJS包管理和分发工具的源
1. ```
/usr/local/project/node-v21.2.0/bin/npm install --production --registry https://registry.npm.taobao.org
```
2. 若执行上面的指令出现错误：/usr/bin/env: ‘node’: No such file or directory，则执行下列指令解决
  1. 创建node.js的软链接
  2. ```
  ln -s /usr/local/project/node-v21.2.0/bin/node /usr/bin/node
```
3. 然后再次执行第一步即可

根据自己需求的配置修改config.json的配置

{
  "port": "3000",
  "adminAccount": "admin@admin.com",
  "timeout":120000,
  "db": {
    "servername": "127.0.0.1",
    "DATABASE": "yapi",
    "port": 27017,
    "user": "",
    "pass": "",
    "authSource": ""
  }
}

必须在MongoDB创建yapi数据库，并且默认端口为27017，同时MongoDB设置为无需授权即可连接

进入vendors文件夹内安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json配置
1. ```
/usr/local/project/node-v21.2.0/bin/npm run install-server
```
启动服务器，请访问：服务器IP地址:{config.json配置的端口}，初次运行会有个编译的过程，请耐心等候
1. ```
/usr/local/project/node-v21.2.0/bin/node /usr/local/project/yapi/vendors/server/app.js
```
打开浏览器访问YApi，示例中访问地址为：http://服务器ip地址:3000/
3. 初始化默认的管理员账号为："admin@admin.com"，密码："ymfe.org"
5. YApi服务已经成功搭建