文档管理工具 Yapi

使用 Docker 构建 Yapi

1、启动 MongoDB

docker run -d --name mongo-yapi mongo

2、获取 Yapi 镜像

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

3、初始化 Yapi 数据库索引及管理员账号

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

4、启动 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

使用 Yapi

访问 http://localhost:3000 登录账号 admin@admin.com，密码 ymfe.org

 

 

 

1.项目创建

新建项目前一定要先添加分组，因为这个会涉及到后期的成员权限管理，将项目组的组长设置为自己或者项目负责人。如果使用默认的个人空间，那你的项目永远不会被别人看到，就失去了YAPI的意义。

 

新建项目时需要选中所属的项目组，项目组内的成员才有对应的权限使用项目中的接口。

 

 

2.接口创建

进入项目内，左边导航可以看到接口列表，可以根据实际情况对接口进行分类，也可以只使用默认的“公共接口”分类“。添加接口时需要选择所属分类和请求方式。 

 

 

配置接口的Reqeust和Response，支持多种形式，除开mock固定返回值，yapi还为我们提供了丰富的mock变量

 

 

 

例如@name:返回随机的人名，@id返回随机的id，@string返回随机的字符串，@ip返回随机IP，@time返回随机时间，yapi提供了上百种mock参数。 

运行时可以定制不同的环境，推荐将mock地址设置为，也可以指向预发布或测试环境。

 

 

如果想根据不同的传参返回不同的结果，可以在高级mock中添加期望。 

 

 

 

3.swagger导入

Yapi提供了多种现有接口的导入方式，这里只介绍如何对接swagger。 

该段落需要一定研发基础，非研发人员或者未使用swagger管理接口的项目可以跳过该章节。 

url请求： 

swagger地址：http://ip:port/swagger-ui.html

swagger的Json文件：http://ip:port/v2/api-docs

将swagger的Json文件保存为文件，然后在yapi工具导入:

 

 

 

请注意导入模式的区别： 

普通模式：不导入已存在的接口 

智能合并：已存在的接口，将合并返回数据的 response，适用于导入了 swagger 数据，保留对数据结构的改动 

完全覆盖：不保留旧数据，完全使用新数据，适用于接口定义完全交给后端定义