【DevOps】YApi搭建

桃扇骨 2022-10-29 06:22 159阅读 0赞

> 一个原本以为十分钟内能够解决的问题。

### 0. 目录 ###

*   *   *  1. 前言
         *  2. 选择YApi的理由
         *  3. 安装过程
         *   *  3.1 MongoDb搭建
             *  3.2 YApi搭建
         *  4. 效果
         *  5. 其他平台
         *  6. Links

### 1. 前言 ###

随着计算机应用不断普及，人们对于计算机应用在界面美化和操作人性化上的要求以一种肉眼可见的速度不断提升，最终笔者这种面向电子政务的传统软件开发公司也不能幸免，乃至从高层领导层面直接将前后端分离作为基础的开发模式。

前后端分离开发模式之下，前端的专业性确实带来了页面美观度和操作便捷性，以及开发效率的提升(仅就前端功能而言)。只是随之而来的前后端协作困难重重的问题却让前面的那些优势几乎完全被吞没，甚至会产生一种"得不偿失"的感觉。

鉴于以上情况，作为解决方案之一的Mock Service在多年前即被提出并在之后不断被迭代优化，YApi作为其中的佼佼者，笔者在对多款类似的Mock Service进行尝试比较后，最终选择了它。

### 2. 选择YApi的理由 ###

本文是YApi的第一篇，因此在正式开始介绍YApi之前，额外介绍下笔者选择它的理由，读者也可以从中看出我们希望它能帮助我们解决什么问题：

1.  开源且完全自主可控。相较于 eolinker 这类开源/专业版并存的产品(最新版已经完全闭源)，看着一些好功能却无法使用的感觉着实让人不爽（当然这也正是这类产品希望看到的，但笔者人微言轻，实在没有信心能够说服高层领导，当初为了推K8S已经自掏腰包，元气至今都尚未完全恢复）。
2.  提供即时可用的Mock功能。这一块使我们决定引入Mock Service的最大原因，寄希望于其能够帮助我们在研发阶段的前期让前端尽早发现接口定义中的不合理性，尽量避免因为问题发现过晚导致的修复成本暴增的情形出现。
3.  颜值高。不愧是前端设计的产品，在这一块确实更有战斗力。
4.  社区活跃。这一块算是笔者挑选开源项目最看重的属性了。
5.  其他优势。这些基本是每个类似Mock Service都具备的，这里就不赘述了。

### 3. 安装过程 ###

上面扯了那么半天闲话，接下来正式进入我们开始正文。

先介绍下基础的环境：

1.  操作系统为Centos7。
2.  NodeJS版本为 v14.15.4。[NodeJS下载地址][NodeJS]
3.  MongoDb版本为 v4.4.3 。 [MongoDb下载地址][MongoDb]

#### 3.1 MongoDb搭建 ####

安装

# 下载
    wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-rhel70-4.4.3.tgz
    
    # 解压
    tar -zxvf mongodb-linux-x86_64-rhel70-4.4.3.tgz
    # 将解压包拷贝到指定目录
    mv mongodb-linux-x86_64-rhel70-4.4.3  /usr/local/mongodb4   
    
    #增加环境变量
    vi   /etc/profile  
     	export PATH=/usr/local/mongodb4/bin:$PATH
    
    # 让环境变量生效 
    source /etc/profile

配置

### 创建数据库目录
    # 数据存储目录
    mkdir -p /var/lib/mongo
    # 日志文件目录
    mkdir -p /var/log/mongodb
    # 设置权限
    chown `whoami` /var/lib/mongo 
    chown `whoami` /var/log/mongodb
    
    ########################## 启动 Mongodb 服务
    # 这里可能会出错, 读者自行百度解决
    # 这里我们暂时不需要用户名和密码
    mongod --dbpath /var/lib/mongo --logpath /var/log/mongodb/mongod.log --fork
    
    # 验证
    ./mongo

#### 3.2 YApi搭建 ####

前面说过"本来预期是十分钟内解决的，且本文也不该出现"，但之所以耗费大量时间，一是笔者想偷懒用Docker安装以及笔者对于MongoDb完全不熟，二则是官方文档推荐的"可视化部署"，笔者始终能够遇到点问题。

因此以下笔者只介绍笔者安装成功的方法 —— 命令行部署。

mkdir yapi
    cd yapi
    # 没错，笔者在经过几次下载失败之后, 将yapi进行了缓存. 有需要的可以尝试下.
    git clone https://gitee.com/lqzkcx3/yapi-copy.git vendors
    # 以下: 复制完成后请修改相关配置, 例如本例中我们并没有设置用户名和密码
    cp vendors/config_example.json ./config.json 
    cd vendors
    npm install --production --registry https://registry.npm.taobao.org
    
    # 安装程序会初始化数据库索引和管理员账号，管理员账号名可在 config.json 配置
    # 初始化管理员账号成功,账号名："admin@admin.com"，密码："ymfe.org"
    npm run install-server 
    
    # 启动服务
    node server/app.js

### 4. 效果 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70]

### 5. 其他平台 ###

本小节列举下笔者在调研过程中收集的一些类似工具：

1.  [apifox][] 专业版收费
2.  [Wiremock][] 需要二次开发
3.  [SoupUI][]
4.  [apipost][]
5.  [RAP2 ][RAP2]
6.  [lyrebird ][lyrebird] 美团开源
7.  [MOCO][] 知道这个东西主要是因为笔者最近学习了作者的极客时间专栏。
8.  [用友 - MOCK][- MOCK] 基于YApi
9.  [EasyMock][]

### 6. Links ###

1.  [YApi - 内网部署][YApi -]
2.  [YApi - GitHub][]
3.  [YAPI守护线程的安装 - pm2][YAPI_ - pm2]

[NodeJS]: http://nodejs.cn/download/
[MongoDb]: https://www.mongodb.com/try/download/community
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2xxemtjeDM_size_16_color_FFFFFF_t_70]: /images/20221024/9fa7cce1db014e2da762b7ca56438050.png
[apifox]: https://www.apifox.cn/#
[Wiremock]: https://blog.csdn.net/liuchunming033/article/details/52399397
[SoupUI]: https://www.cnblogs.com/helenMemery/p/6343493.html
[apipost]: https://www.cnblogs.com/phpwechat/p/10487077.html
[RAP2]: https://github.com/thx/rap2-delos
[lyrebird]: http://blog.yixao.net/share/17286.html
[MOCO]: https://github.com/dreamhead/moco
[- MOCK]: https://mock.yonyoucloud.com/
[EasyMock]: https://www.toutiao.com/a6820924754329862667
[YApi -]: https://yapi.baidu.com/doc/devops/index.html
[YApi - GitHub]: https://github.com/YMFE/yapi
[YAPI_ - pm2]: https://blog.csdn.net/justyman/article/details/105859455