前言
因为最近换了新公司,前后端对接中没有没有使用任何接口文档系统,直接都是丢个txt或者word文件,为了提升开发效率,尝试了使用YApi进行接口文档管理。
YApi旨在为开发、产品、测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、发布、维护 API。支持权限控制、可视化接口管理、mock接口、自动化测试、数据导入、插件机制等功能。同时支持内网自己部署,项目由去哪儿网大前端技术中心维护,使用了Koa + mongoose框架开发,不管是部署还是配置方面对前端很友好,那么接下来开整吧!
环境准备
因为YApi是基于node开发,数据存储在mongodb数据库,因此在安装之前需要在服务器安装node和mondodb。
mongoDB安装
下载mongodb安装包,下载地址:点我可以直接下载压缩包
下载后在服务器解压
tar -xvf mongodb-linux-x86_64-ubuntu2004-4.4.5
解压后重命名
mv mongodb-linux-x86_64-ubuntu2004-4.4.5/ mongodb
- 将mongodb文件夹移动到/usr/local
mv mongodb /usr/local
- 添加环境变量
sudo vim /etc/profile
- 添加以下内容并保存
export PATH=/usr/local/mongodb/bin:$PATH
使修改生效
source /etc/profile
创建用于存放数据和日志文件的文件夹,并修改其权限增加读写权限
# 数据存储目录
sudo mkdir -p /var/lib/mongo
# 日志文件目录
sudo mkdir -p /var/log/mongo