YApi 安装和配置指南

YApi 安装和配置指南

yapi YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台 项目地址: https://gitcode.com/gh_mirrors/ya/yapi

1. 项目基础介绍和主要编程语言

项目基础介绍

YApi 是一个高效、易用、功能强大的 API 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。它可以帮助开发者轻松创建、发布、维护 API，并提供了优秀的交互体验。YApi 支持本地部署，信息安全有保障，适用于大型企业级项目。

主要编程语言

YApi 主要使用 JavaScript 语言开发，前端使用 React 框架，后端使用 Node.js。

2. 项目使用的关键技术和框架

关键技术和框架

• Node.js: 后端运行环境。
• MongoDB: 数据库，用于存储项目数据。
• React: 前端框架，用于构建用户界面。
• Mock.js: 用于生成随机数据，支持接口的 Mock 功能。
• Json5: 用于定义接口返回数据的结构和文档。

3. 项目安装和配置的准备工作和详细的安装步骤

准备工作

在开始安装 YApi 之前，请确保您的系统满足以下要求：

• Node.js (版本 7.6 以上)
• MongoDB (版本 2.6 以上)
• Git (用于克隆项目代码)

安装步骤

步骤 1: 克隆项目代码

首先，使用 Git 克隆 YApi 项目代码到本地：

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

步骤 2: 安装依赖

进入项目目录后，使用 npm 安装项目依赖：

npm install

步骤 3: 启动可视化部署程序

使用 YApi 提供的 CLI 工具启动可视化部署程序：

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

步骤 4: 配置和部署

在浏览器中打开 http://127.0.0.1:9090，按照提示输入相应的配置信息，点击“开始部署”。部署完成后，按照提示启动服务器。

步骤 5: 启动服务器

部署完成后，执行以下命令启动服务器：

node vendors/server/app.js

步骤 6: 登录系统

在浏览器中打开指定 URL，使用管理员邮箱和默认密码 ymfe.org 登录系统。默认密码可以在个人中心修改。

服务管理

为了方便服务管理维护，建议使用 pm2 进行服务管理：

npm install pm2 -g
cd [项目目录]
pm2 start "vendors/server/app.js" --name yapi

升级

升级项目版本时，执行以下命令：

cd [项目目录]
yapi ls // 查看版本号列表
yapi update // 更新到最新版本
yapi update -v [Version] // 更新到指定版本

通过以上步骤，您可以顺利完成 YApi 的安装和配置，开始使用这个强大的 API 管理平台。

yapi YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台 项目地址: https://gitcode.com/gh_mirrors/ya/yapi