系统运维

YApi API管理平台的安装与部署指南

浅时光博客 · 5月18日 · 2024年 · 773 次已读

一、YApi平台介绍

YApi是一个开源的、可本地部署的、打通前后端及QA的、可视化的接口管理平台,提供了包括接口管理、接口自动化测试、接口文档管理等功能。使用YApi可以方便地管理接口,减少重复工作和人力成本,同时也提高了接口的可维护性和可读性。YApi支持多人协作开发,也可以集成到现有的团队开发流程中。

项目地址:https://github.com/YM原文链接:https://www.dqzboy.comFE/yapi

二、Yapi功能特性

  • 权限管理:YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求
  • 可视化接口管理:基于 websocket 的多人协作接口编辑功能和类 postman 测试工具,让多人协作成倍提升开发效率
  • Mock Server:易用的 Mock Server,再也不用担心 mock 数据的生成了
  • 自动化测试:完善的接口自动化测试,保证数据的正确性
  • 数据导入:支持导入 swagger, postman, har 数据格式,方便迁移旧项目
  • 插件机制:强大的插件机制,满足各类业务需求

三、YApi安装部署

1、环境要求

  • nodejs(7.6+)
  • mongodb(2.6+)
  • git

2、MongoDB安装

2.1:下载部署

wget https://mirrors.tuna.tsinghua.edu.cn/mongodb/yum/el7/RPMS/mongodb-org-5.0.5-1.el7.x86_64.rpm --no-check-certificate
wget https://mirrors.tuna.tsinghua.edu.cn/mongodb/yum/el7/RPMS/mongodb-org-mongos-5.0.5-1.el7.x86_64.rpm --no-check-certificate
wget https://mirrors.tuna.tsinghua.edu.cn/mongodb/yum/el7/RPMS/mongodb-org-server-5.0.5-1.el7.x86_64.rpm --no-check-certificate
wget https://mirrors.tuna.tsinghua.edu.cn/mongodb/yum/el7/RPMS/mongodb-org-shell-5.0.5-1.el7.x86_64.rpm --no-check-certificate
wget https://mirrors.tuna.tsinghua.edu.cn/mongodb/yum/el7/RPMS/mongodb-org-tools-5.0.5-1.el7.x86_64.rpm --no-check-certificate
wget https://mirrors.tuna.tsinghua.edu.cn/mongodb/yum/el7/RPMS/mongodb-org-database-tools-extra-5.0.5-1.el7.x86_64.rpm --no-check-certificate
wget https://mirrors.tuna.tsinghua.edu.cn/mongodb/yum/el7/RPMS/mongodb-mongosh-1.1.7.el7.x86_64.rpm --no-check-certificate
wget https://mirrors.tuna.tsinghua.edu.cn/mongodb/yum/el7/RPMS/mongodb-database-tools-100.5.1.x86_64.rpm --no-check-certificate
wget https://mirrors.tuna.tsinghua.edu.cn/mongodb/yum/el7/RPMS/mongodb-org-database-5.0.5-1.el7.x86_64.rpm --no-check-certificate

yum install mongodb-*

2.2:修改配置

[root@localhost ~]# vim /etc/mongod.conf
文章来源(Source):https://www.dqzboy.com

2.3:启动服务

[root@localhost ~]# systemctl start mongod.service
[root@localhost ~]# systemctl enable mongod.service
[root@localhost ~]# lsof -i:27017|awk '{print $1}'|grep -w mongod|wc -l

2.4:建数据库

# 创建数据库
> use yapi	#进入yapi数据库,没有则创建
switched to db admin

# 创建DB用户
> use yapi	#进入该数据库下,创建数据库用户
> db.createUser( {user: "root",pwd: "123456",roles: [ { role: "dbAdmin", db: "yapi" } ]})

3、YApi手动部署

3.1:克隆仓库

mkdir yapi 
cd yapi 

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

#github加速地址
git clone https://hub.fastgit.org/YMFE/yapi.git vendors
cp vendors/config_example.json ./config.json // ⚠️ 复制完成后把内容修改为 config.json

3.2:修改配置

#修改config.json
vim ./config.json
{
  "port": "3000",
  "adminAccount": "[email protected]",
  "timeout":120000,
  "db": {
    "servername": "127.0.0.1",
    "DATABASE": "yapi",
    "port": 27017,
    "user": "root",
    "pass": "123456",
    "authSource": ""
  },
  "mail": {
    "enable": true,
    "host": "smtp.163.com",
    "port": 465,
    "from": "***@163.com",
    "auth": {
      "user": "***@163.com",
      "pass": "*****"
    }
  }
}

3.3:安装部署

cd vendors 
rm -f package-lock.json // ⚠️一定要删除 package-lock.json 
npm install --production --registry https://registry.npm.taobao.org 
npm run install-server

3.4:系统启动

]# vim /etc/systemd/system/yapi.service

[Unit]
Description=yapi
After=network.target remote-fs.target nss-lookup.target

[Service]
Type=forking
ExecStart=/bin/bash -c 'nohup node /usr/local/yapi/vendors/server/app.js >/dev/null 2>&1 &'
ExecReload=/bin/bash -c 'kill -9 $(ps -ef|grep app.js|grep -v grep|awk '{print $2}');/usr/local/yapi/vendors/server/app.js >/dev/null 2>&1 &'
ExecStop=/bin/bash -c 'kill -9 $(ps -ef|grep app.js|grep -v grep|awk '{print $2}')'
PrivateTmp=true

[Install]
WantedBy=multi-user.target


systemctl daemon-reload
systemctl start yapi
systemctl enable yapi

ps -ef|grep yapi

四、Yapi浏览访问


YApi平台默认监听端口为:3000

初始化管理员账号成功,账号名:”[email protected]”,密码:”ymfe.org”


本文作者:浅时光博客
原文链接:https://www.dqzboy.com/12096.html
版权声明:知识共享署名-相同方式共享 4.0 国际 (CC BY-NC-SA 4.0)协议进行许可,转载时请以>超链接形式标明文章原始出处和作者信息
免责声明:本站内容仅供个人学习与研究,严禁用于商业或非法目的。请在下载后24小时内删除相应内容。继续浏览或下载即表明您接受上述条件,任何后果由用户自行承担。

0 条回应

必须 注册 为本站用户, 登录 后才可以发表评论!