还在为接口管理发愁吗？来试试这个工

友好的接口文档，基于websocket的多人协作接口编辑功能和类postman测试工具，让多人协作成倍提升开发效率

MockServer

基于Mockjs，使用简单功能强大

扁平化管理模式

接口管理的逻辑较为复杂，操作频率高，层层审批将严重拖慢生产效率，因此传统的金字塔管理模式并不适用。

YAPI 将扁平化管理模式的思想引入到产品的权限管理中，超级管理员拥有最高的权限，并将权限分配给若干组长，超级管理员只需管理组长即可，实际上管理YAPI各大分组与项目的是“组长”。组长对分组或项目负责，一般由BU负责人/项目负责人担任。

二、安装步骤

使用 Docker 构建 Yapi

• 启动 MongoDB

docker run -d --name mongo-yapi -p 27017:27017 -v /home/yapi/mongodb/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

• 启动 Yapi 服务

docker run -d  --name yapi --link mongo-yapi:mongo --workdir /api/vendors  -p 3000:3000/tcp registry.cn-hangzhou.aliyuncs.com/anoy/yapi server/app.js

• 使用 Yapi

访问http://localhost:3000 登录账号[email protected]，密码ymfe.org

三、认识YApi

在开始使用 YApi 之前，我们先来熟悉一下 YApi 的网站结构，这将让你快速了解YApi。

登录与注册

想要使用 YApi ，首先要注册账号。

首页

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

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

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

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

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

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

项目页

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

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

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

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

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

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

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

个人中心

鼠标移动到右上角的用户头像或用户名上，即可点击“个人中心”查看个人信息。

在个人信息页面可以查看并修改自己的用户名、密码等信息。

四、创建第一个API

如何创建接口？

把大象装进冰箱分几步？三步：把冰箱门打开，把大象装进去，关门，搞定~

新建接口分几步？也是三步：

• 获取权限
• 找到一个项目
• 新建接口

搞定~

获取权限

新用户登录拥有 个人空间 分组下的全部权限，个人空间分组仅自己可见，因此可以在这里任意试用 YApi 的功能。

除此以外没有任何项目或分组的权限，只能浏览已存在分组下面的公开项目。

如果找不到想找的项目，可能是尚未成为项目成员，此时应联系 项目组长 将你加入该项目。

怎样联系组长？

• 想创建分组，请看: 创建分组
• 想创建项目，请看: 创建项目

想了解更多权限信息，请查看权限列表

选择项目

• 如果你已经登录，会在首页右侧看到一些项目 (可以在左侧的分组列表切换分组来查看不同分组下的项目)。
• 点击一个项目，进入该项目的详情页。

新建接口

• 点击左侧接口分组右侧的菜单按钮，选择 添加接口，或者点击接口列表右上角的 添加接口。

• 选择接口分类，输入接口名称和接口路径，点击 提交。

• 恭喜你！创建了第一个YApi的接口，你可以看到在左侧看到接口名称，右侧有该接口的信息预览。

五、指北君有话说

YApi让接口开发更简单高效，让接口的管理更具可读性、可维护性，让团队协作更合理。可以提高项目中的工作效率，快来试试吧！

关注公众号 [程序员了不起]回复[eee113] 即可获取navicat绿版。