产品经理利器——YApi--- api接口管理神器从部署到使用

最新推荐文章于 2025-05-30 09:00:00 发布

原创最新推荐文章于 2025-05-30 09:00:00 发布 · 678 阅读

2 ·

CC 4.0 BY-SA版权

文章标签：

#java #docker #编辑器 #node.js

手把手带零基础实习生系列专栏收录该内容

11 篇文章

订阅专栏

YApi是一款强大的API管理平台，适用于开发、产品和测试人员。它提供了简单的接口管理和优秀的交互体验，支持接口定义、调试、自动化测试及Mock功能。本文详细介绍了如何通过Docker在腾讯云服务器上部署YApi，以及使用步骤，帮助用户快速上手。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >

YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理。

YApi让接口开发更简单高效，让接口的管理更具可读性、可维护性，让团队协作更合理。

源码地址: GitHub - YMFE/yapi: YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台YApi 是一个可本地部署的、打通前后端及QA的、可视化的接口管理平台. Contribute to YMFE/yapi development by creating an account on GitHub.https://github.com/YMFE/yapi

官方文档: YApi 接口管理平台YApi 是高效、易用、功能强大的 api 管理平台，旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API，YApi 还为用户提供了优秀的交互体验，开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理https://hellosean1025.github.io/yapi/

基于 Json5 和 Mockjs 定义接口返回数据的结构和文档，效率提升多倍
扁平化权限设计，即保证了大型企业级项目的管理，又保证了易用性
类似 postman 的接口调试
自动化测试, 支持对 Response 断言
MockServer 除支持普通的随机 mock 外，还增加了 Mock 期望功能，根据设置的请求过滤规则，返回期望数据
支持 postman, har, swagger 数据导入
免费开源，内网部署，信息再也不怕泄露了

一、YApi部署（Docker+腾讯云服务器）

写在最前面，官方介绍了好几种安装的方式，本人习惯使用docker来安装部署，docker的在后期再做详细的介绍分享。

———默认已经安装docker

1、创建MongoDB数据卷

# docker volume create mongo_data_yapi

2、启动MongoDB

# docker run -d --name mongo-yapi -v mongo_data_yapi:/data/db mongo

3、从阿里云仓库获取YApi镜像

# docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

使用docker命令查看是否拉取成功

#docker images

4、初始化YApi数据库索引及管理员账户

# docker run -it --rm  --link mongo-yapi:mongo  --entrypoint npm  
--workdir /api/vendors  registry.cn-hangzhou.aliyuncs.com/anoy/yapi 
run install-server

5、创建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.js

6、访问：

IP：3000来访问YApi服务

注册一个账号使用：

正常创建项目：

二、YApi使用

以下内容来自官方使用手册！*学习新技术，记得学会查看官方文档呦！

首页：

登录后进入首页，首页展示了分组与项目。

此时你作为新用户，没有任何分组与项目的权限，因此只能搜索、浏览 “公开项目” 的接口，如果在首页找不到任何项目，请联系管理员将你加入对应项目。

1首页头部展示了当前所在的位置、搜索框、新建项目、查看文档和用户信息。

2首页左侧展示分组信息，“分组”是“项目”的集合，只有超级管理员可以管理分组。

3首页右侧是分组下的项目和成员列表，点击左侧的某个分组，右侧会出现该分组下的项目和成员信息。

4点击项目右上角的星星即可关注项目，关注的项目可以在“我的关注”页面查看

项目页：

点击一个项目，进入项目页，项目页展示了属于该项目的全部接口，并提供项目、接口的全部操作。

此时你作为新用户，只能浏览接口信息，不可以编辑项目或接口，如果需要编辑，请联系管理员将你加入该项目。

1项目页左侧的 “接口列表” 展示了该项目下的所有接口，右侧默认显示该项目下所有接口的列表。

2点击左侧的某个接口，右侧会出现“预览”、“编辑”和“运行”。

3点击左侧的 “测试集合” 使用测试集功能。

4点击二级导航的“设置”，项目组长即可编辑项目信息和管理成员列表。

5点击二级导航的“动态”，即可查看项目的操作日志。