保姆级教程：在Linux系统上部署和使用接口平台YApi和接口文档生成插件

前言

背景 ：在很多公司中，接口文档通常通过集成Swagger来维护，特别是Knife4j（Swagger的增强解决方案）。不过，对于产品型开发团队而言，Swagger可能存在一些局限性，需要更加灵活和强大的接口文档管理工具。

YApi的优势 ：YApi是一款开源的接口文档管理平台，具有强大的功能和友好的用户界面，可以帮助团队轻松创建、维护和共享接口文档。此外，YApi还提供多种接口文档生成插件，可以将接口文档轻松地集成到现有系统中。

准备工作

1. 服务器环境

• 一台具有root权限的Linux服务器（推荐CentOS 7或更高版本）。
• 稳定的网络连接。

2. 软件环境

• Node.js 12或更高版本。
• MongoDB 3.6或更高版本。

部署YApi

1. 安装Node.js和MongoDB

Node.js安装 ：

curl -sL https://rpm.nodesource.com/setup_18.x | sudo bash -
sudo yum install -y nodejs

MongoDB安装 ：

sudo yum install -y mongodb-org
sudo systemctl start mongod
sudo systemctl enable mongod

2. 下载YApi代码

git clone https://github.com/YMFE/yapi.git
cd yapi

3. 安装依赖项

npm install

4. 配置YApi

在yapi目录下创建名为.env的配置文件，并添加如下内容：

DB_HOST=127.0.0.1
DB_PORT=27017
DB_NAME=yapi
DB_USER=root
DB_PASS=password
JWT_SECRET=your_secret_key

将DB_HOST、DB_PORT、DB_NAME、DB_USER和DB_PASS替换为您的MongoDB服务器信息，将JWT_SECRET替换为一个安全的密钥。

5. 启动YApi

npm run start

部署接口文档生成插件

1. 安装Swagger插件

cd plugins/swagger
npm install

2. 配置Swagger插件

在swagger目录下创建名为.env的配置文件，并添加如下内容：

YAPI_ADDR=http://localhost:3000

将YAPI_ADDR替换为您的YApi服务器地址。

3. 启动Swagger插件

npm run start

使用YApi

1. 创建项目

登录YApi管理界面，点击“新建项目”按钮，输入项目名称和，点击“创建”按钮。

2. 添加接口

在项目中，点击“添加接口”按钮，输入接口名称、路径、方法、请求参数、响应参数等信息，点击“保存”按钮。

3. 生成接口文档

在项目中，点击“导出”按钮，选择“Swagger”格式，点击“下载”按钮。

4. 集成接口文档

将下载的Swagger文档集成到您的系统中，即可在系统中查看和使用接口文档。

总结

通过以上步骤，您已经成功地在Linux系统上部署了YApi接口平台和接口文档生成插件，可以轻松创建、维护和共享接口文档，提高开发效率和文档维护的准确性。