顶尖 API 文档管理工具 (Yapi)

前言介绍

Yapi 由 YMFE 开源，旨在为开发、产品、测试人员提供更优雅的接口管理服务，可以帮助开发者轻松创建、发布、维护 API。

• 权限管理
  YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求

• 可视化接口管理
  基于 websocket 的多人协作接口编辑功能和类 postman 测试工具，让多人协作成倍提升开发效率

• Mock Server
  易用的 Mock Server，再也不用担心 mock 数据的生成了

• 自动化测试
  完善的接口自动化测试,保证数据的正确性

• 数据导入
  支持导入 swagger, postman, har 数据格式，方便迁移旧项目

• 插件机制
  强大的插件机制，满足各类业务需求

去哪儿网移动架构组（YMFE）是由FE，iOS和Android工程师共同组成的，去哪儿最具想象力、创造力和影响力的大前端团队。

使用 Docker 构建 Yapi

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

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

自定义配置文件挂载到目录 /api/config.json，官方自定义配置文件 -> 传送门

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

使用 Yapi

访问地址 http://localhost:3000

登录，账号 [email protected]，密码 anoyi.com

至此，帅气的 Yapi 就可以轻松使用啦！更多文档信息，请参考

• Yapi 官方文档
• Yapi 版本更新记录

其他相关操作

关闭 mongo-yapi

docker stop mongo-yapi

启动 mongo-yapi

docker start mongo-yapi

关闭 Yapi

docker stop yapi

启动 Yapi

docker start yapi

升级 Yapi

# 1、停止并删除旧版容器
docker rm -f yapi

# 2、获取最新镜像
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi

下载指定版本
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi:v1.3.16

重命名镜像tag
docker tag 1af2bc1b190b registry.cn-hangzhou.aliyuncs.com/anoy/yapi:latest

# 3、启动新容器
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

• docker镜像重命名和tag

docker镜像重命名和tag
docker tag IMAGEID(镜像id) REPOSITORY:TAG（仓库：标签）
#例子
docker tag ca1b6b825289 registry.cn-hangzhou.aliyuncs.com/xxxxxxx:v1.0

删除相同名称 和images id的镜像
repository：tag的组合来删除特殊的镜像
docker rmi registry.cn-hangzhou.aliyuncs.com/anoy/yapi:v1.3.16
删除相同images id，不同名称的镜像
docker rmi registry.cn-hangzhou.aliyuncs.com/anoy/yapi/latest

删除容器
docker rm 容器名称

• 转自 https://www.jianshu.com/p/a97d2efb23c5