手把手教你搭建开源的接口管理平台

前言

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

• 权限管理 YApi 成熟的团队管理扁平化项目权限配置满足各类企业的需求
• 可视化接口管理 基于 websocket的多人协作接口编辑功能和类 postman 测试工具，让多人协作成倍提升开发效率
• Mock Server 易用的 Mock Server，再也不用担心 mock 数据的生成了
• 自动化测试 完善的接口自动化测试,保证数据的正确性
• 数据导入 支持导入swagger, postman, har数据格式，方便迁移旧项目
• 插件机制 强大的插件机制，满足各类业务需求

1.环境要求

• nodejs（7.6+)
• mongodb（2.6+）

2.yapi安装

1.启动 MongoDB

# docker run -d --name mongo-yapi mongo

2.获取yapi镜像

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

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

# 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

5.访问

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

6.其他命令

#启动停止
# docker stop yapi
# docker start yapi
# 开机自启动
# chmod +x /etc/rc.d/rc.local
# systemctl daemon-reload
# sudo service docker restart
# docker start mongo-yapi
# docker start yapi

7.连接mongo

添加端口映射

获取容器ip  
docker inspect $container_name | grep IPAddress

查看docker名称

$docker ps

（b）获取容器docker的ip

docker inspect container_name | grep IPAddress

其中$container_name为NAME值mongo-yapi

docker inspect mongo-yapi | grep IPAddress

studio3 连接mongo

3.使用

官方使用详细文档：https://hellosean1025.github.io/yapi/documents/index.html

yapi安装成功访问 http://localhost:3000,进入登录界面

初始登录账号 admin@admin.com，密码 ymfe.org

测试demo

创建项目

添加接口

接口列表

测试集合

开始测试

单个接口测试报告

服务端自动化测试

复制链接，访问此链接执行自动化测试

数据导入

支持Postman、HAR、Swagger、json

数据导出

为了方便开发者将接口数据分析给第三方或其他使用者，YApi 内置了方便易用的接口数据导出功能。

在 项目 -> 数据管理，选择需要导出的数据方式，一共有三种导出方式，html,markdown,json。然后点击导出按钮，将会下载数据文件。

4.集成jenkins

1.创建项目

2添加配置

在构建里面添加上面提到的自动化测试的链接、在添加轮询保证无人值守持续集成

查看测试报告

在workspace双击Report.html

无人值守持续测试

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，如果有疑问大家可以留言交流，谢谢大家的支持。