前言

随着 Web 技术的发展，前后端分离构架变的越来越流行。前端负责数据的展现和交互，大大细化了开发者的职责，提高了开发效率，但与此同时也带来了一些问题：

对于前端工程师，后端提供的接口文档大多是不规范的，有使用 wiki 的，有 word 文档的，甚至还有用即时聊天软件沟通的，后端接口对于前端就像一个黑盒子，经常遇到问题是接口因未知原因增加参数了，参数名变了，参数被删除了。对于后端工程师，接口对接时总是需要写冗杂繁琐的文档，需要大量时间去维护接口文档。

........

还有很多问题就不一一列举了，只要做过前后端分离项目的开发人员，或者做过APP后台接口的开发人员，又或者做过微信小程序的开发人员都会懂的。今天不说太多空话，只是给大家分享一个api管理平台工具，也是我目前在用的一个工具。

市面上关于api管理的工具/系统其实有很多很多，知乎上搜一下各种对比介绍都有，我当时就是这么过来的，咱今天也不争辩谁好谁坏。

关于Yapi

YApi是去哪儿移动架构组开源的API管理系统，是一款完全免费的api管理平台。

官网地址：

示例地址：

使用教程：

系统界面也是很简洁的

其主要特点如下：

· 权限管理

YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求

· 可视化接口管理

基于 websocket 的多人协作接口编辑功能和类 postman 测试工具，让多人协作成倍提升开发效率

· Mock Server

易用的 Mock Server，再也不用担心 mock 数据的生成了

· 自动化测试

完善的接口自动化测试,保证数据的正确性

· 数据导入

支持导入 swagger, postman, har 数据格式，方便迁移旧项目

· 插件机制

强大的插件机制，满足各类业务需求

安装Yapi

Yapi有两种使用方式，一种是在线使用官方提供的系统，这种肯定不适用与大部分公司，另外一种是下载并安装到指定服务器，我们这里介绍下载安装到centos中。

官方教程中有关于内网部署系统的文档说明，但是我在使用的过程中发现有一些坑，安装过程可能没有文档写的那么的简单。

内网部署文档：

安装环境要求：

· nodejs(7.6+) yapi是用nodejs开发的，所以需要此环境编译运行

· mongodb(2.6+) 用来存储系统的数据

· git 为了在线下载yapi源码

方式一. 可视化部署[推荐]

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

方式二. 命令行部署

*如果 github 压缩文件无法下载，或需要部署到一些特殊的服务器，可尝试此方法

注：上述安装都会有个很大的问题，就是npm的使用，网络原因，npm在执行某些命令的时候经常卡死不动，这个时候需要采用淘宝提供的景象才可以。可以看这里或者请教专业前端人员。

安装后配置

以上两种方法执行后，都只是完成了系统的初步安装，还需要打开浏览器页面，完成系统的配置才行。

这里以第一种方式为例：

第一个命令执行后：

根据信息，需要切换到对应的目录才能执行yapi命令

然后打开浏览器访问即可，记得关闭防火墙

浏览器打开是个配置页面，填写基本信息：

数据库认证那里，默认安装的mongodb是没有密码的，所以不需要认证，如果修改了密码，那就需要填写了

填写后确定，就会弹出安装进度信息：

后台系统也会实时打印日志信息：

安装过程可能会慢一点，需要耐心等待了。如果以上方式失败了，尝试第二种，先把文件下载了然后安装。

安装后就可以访问使用系统了：

登录用户名就是配置的管理员邮箱，密码默认是 ymfe.org，登陆后可以自行修改。

默认启动是前台启动，我们需要改为后台运行才可以。这里推荐使用pm2管理node服务器的启动、停止等。官网教程中有说明。如果你会npm，你会很在行的。

登录之后的系统长这个样子：

关于系统的使用，可以参考官网的教程，介绍的还是很详细的。或者等我改天再分享。

补充

以下补充的知识仅为本文的yapi服务，所以不做过多介绍，只说明基本操作。

git安装

一个命令：

mongodb安装

官网安装文档：

1、 在/etc/yum.repos.d创建一个mongodb-org.repo源文件

编辑此文件

这段内容可以从mongodb官网复制，根据你所安装的版本选择

保存退出

2、 更新yum源

3、 安装mongodb

4、 启动mongod服务

5、 设置为开机启动

6、 配置远程访问，默认只能本机访问。如果不需要远程访问，这一步可以省略

mongodb配置文件为/etc/mongod.conf：

默认监听127.0.0.1，注释掉即可远程访问

7、 如果需要修改认证，建议查阅相关文档，这里不再介绍

nodejs安装

官网下载所需要的nodejs，建议下载8.*，淘宝镜像下载地址：

我这里下载的压缩包：

解压即可：

将解压后的文件目录配置到path中即可使用npm相关命令：

测试命令是否可用：

pm2安装

一行命令搞定：

常用命令：

还可以关注我的微信公众号一同交流：code_mrzhou