接口文档Yapi+Docker的安装与配置
一、什么是Yapi?
Yapi 由 YMFE 开源,旨在为开发、产品、测试人员提供更优雅的接口管理服务,可以帮助开发者轻松创建、发布、维护 API。
1.权限管理 YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求
2.可视化接口管理 基于 websocket 的多人协作接口编辑功能和类 postman 测试工具,让多人协作成倍提升开发效率
3.Mock Server 易用的 Mock Server,再也不用担心 mock 数据的生成了
4.自动化测试 完善的接口自动化测试,保证数据的正确性
5.数据导入 支持导入 swagger, postman, har 数据格式,方便迁移旧项目
6.插件机制 强大的插件机制,满足各类业务需求
二、安装docker部署
1.yapi的源码在:https://github.com/YMFE/yapi/blob/master/config_example.json
2.安装docker.配置阿里云加速源
前提条件:
目前,CentOS 仅发行版本中的内核支持 Docker。Docker 运行在 CentOS 7 上,要求系统为64位、系统内核版本为 3.10 以上。Docker 运行在 CentOS-6.5 或更高的版本的 CentOS 上,要求系统为64位、系统内核版本为 2.6.32-431 或者更高版本。使用 yum 安装(CentOS 7下)Docker 要求 CentOS 系统的内核版本高于 3.10 ,查看本页面的前提条件来验证你的CentOS 版本是否支持 Docker 。
三、使用 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 镜像,版本信息可在 阿里云镜像仓库 查看 :
地址: https://dev.aliyun.com/detail.html?spm=5176.1972343.2.26.I97LV8&repoId=139034
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
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.使用 Yapi
访问 http://localhost:3000 登录账号admin@admin.com,密码ymfe.org
7.其他相关操作
7.1关闭 Yapi
docker stop yapi
7.2启动 Yapi
docker start yapi
7.3停止并删除旧版容器
docker rm -f yapi
7.4获取最新镜像
docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
7.5启动新容器
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