阅读量:4
一、YAPI介绍
YAPI是一个开源的、免费的、可视化的接口管理工具。它主要用于帮助团队管理和维护Web API接口，有助于简化API开发过程中的沟通和协作。
以下是关于YAPI的一些主要特点和功能：
接口管理：YAPI提供了一个直观的界面，用于管理和组织接口，包括创建、编辑、删除接口等功能。
接口文档：YAPI支持自动生成接口文档，可以根据接口的定义和注释自动生成文档，方便团队成员查阅和理解接口的使用方式。
Mock数据：YAPI支持生成Mock数据，可以模拟接口的返回结果，方便前端开发人员在接口未完成时进行开发和调试。
权限管理：YAPI支持权限管理功能，可以根据团队成员的角色设置不同的权限，保护接口数据的安全性。
版本控制：YAPI支持接口版本控制，可以方便地管理接口的变更历史，并进行版本回滚和比较。
团队协作：YAPI提供了团队协作功能，可以邀请团队成员共同参与接口的管理和开发，提高团队协作效率。
插件扩展：YAPI支持插件扩展机制，可以根据团队的需求安装和使用各种插件，扩展YAPI的功能。
总的来说，YAPI是一个功能强大、易于使用的接口管理工具，可以帮助团队更好地管理和维护Web API接口，提高开发效率和协作质量。
二、部署
1、环境
node.js \ mongodb \ yapi
2、更新软件包管理
使用以下命令更新服务器上的软件包管理器。
- 对于 Ubuntu/Debian：
sudo apt update - 对于 CentOS/RHEL：
sudo yum update安装 Node.js 的过程会因操作系统的不同而有所差异。以下是针对两种常见 Linux 发行版的基本安装指南：
- 在 Ubuntu 或 Debian 操作系统上，您可以通过执行以下命令来安装 Node.js
sudo apt install nodejs - 在 CentOS 或 RHEL 系统上，使用以下命令进行安装：
sudo yum install nodejs 需要指出的是，使用上述方法安装 Node.js 可能不会得到最新版本。如果您需要安装特定版本的 Node.js，可以采用版本管理工具，比如 nvm（Node Version Manager）或 n，这些工具可以让您灵活切换和管理不同版本的 Node.js。
3、安装Node.JS
对于 Ubuntu 或 Debian 操作系统，你可以通过以下命令来安装 Node.js：
sudo apt install nodejs 对于 CentOS 或 RHEL 操作系统，你可以使用以下命令来安装 Node.js：
sudo yum install nodejs验证 Node.js 安装：
node -v- 运行以下命令，确认 Node.js 是否正确安装并查看版本号。
安装 npm：
npm -v- npm 是 Node.js 的包管理工具，也会随 Node.js 一起安装。
- 再次运行验证命令来确认 npm 安装是否成功。
4、安装MongoDB（2.6+）
在 CentOS 系统上安装 MongoDB，可以按照以下简化的步骤进行：
首先，您需要导入 MongoDB 的 GPG 公钥，这是为了验证下载包的真实性和安全性。请在终端执行此命令，以导入 GPG 公钥：
sudo rpm --import https://www.mongodb.org/static/pgp/server-4.4.asc 其次，创建一个 MongoDB 仓库配置文件 /etc/yum.repos.d/mongodb-org.repo，您可以使用 vi 编辑器来创建并编辑该文件：
sudo vi /etc/yum.repos.d/mongodb-org.repo 在文本编辑器中，复制并粘贴以下内容以配置 MongoDB 4.4 版本的仓库：
[mongodb-org-4.4] name=MongoDB Repository baseurl=https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/4.4/x86_64/ gpgcheck=1 enabled=1 gpgkey=https://www.mongodb.org/static/pgp/server-4.4.asc 完成这些步骤后，保存文件并退出编辑器。这样就配置好了 MongoDB 4.4 版本的仓库。
当使用 yum 在 CentOS 系统上安装 MongoDB 时，请按照以下步骤操作：
- 安装 MongoDB。在终端里输入下面的命令进行安装：
sudo yum install -y mongodb-org 这个命令将会自动下载并安装 MongoDB 及其所有相关组件。
- 安装完成之后，接下来启动 MongoDB 服务。请运行以下命令来启动服务：
sudo systemctl start mongod - 为了确认 MongoDB 服务是否已成功启动，您可以使用以下命令检查服务状态：
sudo systemctl status mongod 如果终端显示出 "active (running)" 状态，意味着 MongoDB 服务已经启动并运行正常。
- 最后，如果您希望 MongoDB 服务在系统启动时自动运行，执行如下命令来设置开机自启动：
sudo systemctl enable mongod 以上步骤将帮助您成功安装并运行 MongoDB，并确保它在系统重启后自动启动。
5、安装YApi
官方文档参考地址：YMFE/yapi: YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台 (github.com)
若要在您的服务器上安装 YApi，您可以按照以下精简的步骤操作：
- 选择一个合适的目录来存放 YApi，例如
/opt或/usr/local。下面的操作将使用/opt目录：
cd /opt mkdir YApi cd YApi 这些命令进入到 /opt 目录，接着创建一个名叫 YApi 的新目录，并进入该目录。
- 在创建好的 YApi 目录中，使用以下命令通过 npm 下载并全局安装
yapi-cli工具，我们这里使用了淘宝的 npm 镜像源以加快安装速度：
npm install -g yapi-cli --registry https://registry.npm.taobao.org - 安装好 YApi 命令行工具后，通过执行以下命令来启动 YApi 服务器：
yapi server - 确保服务器的 9090 端口是开放状态，以便能够通过网络访问 YApi。
按照这些步骤，YApi 应该已经正确安装并且开始在您的服务器上运行。现在您可以通过浏览器访问 http://<您的服务器IP地址>:9090 来使用 YApi 了。
