还在烦恼接口开发？试试Yapi吧

Posted 2021-07-28 攻城狮白玉

目录

一、接口管理的问题

二、什么是Yapi

三、软件部署

3.1 环境要求

3.2 前期准备

3.2.1 nodejs安装

3.2.2 Mongodb安装

3.2.3 安装Yapi

---

一、接口管理的问题

当前后端分离之后，面对接口开发的日常如下：

前端开发——难受，这个接口都什么东西呀，说明都不清楚，后端的大佬给个测试数据很难么？你怎么swagger又关了？

后端开发——哎呀，我都没时间开发完接口，为啥还要我写接口文档，前端的兄弟不能给力一些嘛？哭死，前端又传了旧接口的参数。。。

上述日常，暴露除了前后端分离后，面对接口管理的几个痛点：

• 后端开发没时间写接口文档
• 写了接口没有相应的测试数据
• 后端改了接口之后前端没法同步
• 后端关了swagger之后，前端无法调试接口

二、什么是Yapi

Yapi是旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API。这句话是在yapi的官网摘抄的，清晰明了的说明了yapi接口管理工具解决的问题

yapi的功能特性如下：

• 可视化接口管理
• 数据mock
• 自动化接口测试
• 数据导入（各类数据，包括swagger、har、postman、json等）
• 权限管理
• 支持本地化部署
• 支持插件
• 支持二次开发

三、软件部署

这么好用的软件，咱们当然要部署来使用呀

3.1 环境要求

• nodejs（7.6+)

• mongodb（2.6+）

3.2 前期准备

3.2.1 nodejs安装

首先安装nodejs8，三条命令简单安装nodejs8

yum install -y centos-release-scl-rh

yum install -y rh-nodejs8

scl enable rh-nodejs8 bash

最后一条命令是把nodejs 添加到环境变量中

node -v

执行之后可以看到nodejs的版本是v8.16.1

 

3.2.2 Mongodb安装

wget https://fastdl.mongodb.org/linux/mongodb-linux-x86_64-rhel70-4.4.6.tgz    # 下载
tar -zxvf mongodb-linux-x86_64-rhel70-4.4.6.tgz        # 解压       
mv mongodb-linux-x86_64-rhel70-4.4.6 /usr/local/mongodb
export PATH=/usr/local/mongodb/bin:$PATH   #设置环境变量

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 #启动mongodb服务

打开 /var/log/mongodb/mongod.log 文件看到以下信息，说明启动成功。

 

3.2.3 安装Yapi

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

安装后访问路径http://127.0.0.1:9090 之后就可以看到

cd /root/my-yapi/
node vendors/server/app.js

 

访问API文档管理页面 http://127.0.0.1:3000/