YApi 是什么？
YApi 是一款功能全面且易于使用的 API 管理平台，专为开发、产品及测试团队打造，能够显著提升接口管理效率。通过平台内置的接口数据录入工具，配合简单的点击操作，即可轻松完成接口的创建、发布与维护。本文将详细介绍 YApi 的核心特性，并演示如何使用 Docker 快速搭建完整运行环境。
YApi 的特点
- 权限管理：提供扁平化团队管理与成熟的项目权限配置方案，可满足各类企业的精细化管控需求。
- 可视化接口管理：基于 WebSocket 实现多人实时协作编辑，大幅提升团队协作效率。
- Mock Server：简单快捷的 Mock 服务，方便快速生成模拟数据，助力前后端分离开发。
- 自动化测试：完善的接口自动化测试功能，确保接口数据的正确性与稳定性。
- 数据导入：支持 Swagger、Postman、Har 等多种数据格式导入，轻松完成历史项目迁移。
- 插件机制：强大的插件系统支持灵活扩展，能够适应多样化的业务场景。
官方文档
如需深入了解，可直接查阅官方文档：https://yapi.ymfe.org/documents/index.html
搭建YApi
前提条件：请确保你的服务器已安装 Docker 环境。
创建 MongoDB 数据卷
docker volume create mongo_data_yapi启动 MongoDB
docker run -d --name mongo-yapi -v mongo_data_yapi:/data/db mongo获取 YApi 镜像
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi初始化 YApi 数据库索引及管理员账号
docker run -it --rm \
--link mongo-yapi:mongo \
--entrypoint npm \
--workdir /api/vendors \
registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
run install-server自定义配置文件挂载到目录 /api/config.json
cd /var/lib/docker
mkdir api
touch config.json以下为 config.json 的配置示例：
{
"servername": "127.0.0.1",
"DATABASE": "yapi",
"port": 27017,
"user": "test1",
"pass": "test1",
"port": "3000",
"adminAccount": "admin@admin.com",
"host": "smtp.163.com",
"port": 465,
"from": "@163.com",
"db": { "authSource": "" },
"mail": {
"enable": true,
"auth": {
"user": "@163.com",
"pass": " * "
}
}
}启动 YApi
docker run -d \
--name yapi \
--link mongo-yapi:mongo \
--workdir /api/vendors \
-p 3000:3000 \
registry.cn-hangzhou.aliyuncs.com/anoy/yapi \
server/app.jscurl 127.0.0.1:3000访问YApi
- 默认登录账号：admin@admin.com
- 默认密码：ymfe.org
新建接口
登录成功后，即可开始创建与管理您的接口。
接口功能
