开源可视化接口管理平台-YApi

开源可视化接口管理平台-YApi_第1张图片
  • 去哪儿网大前端技术中心开源项目

  • YApi 的用户

去哪儿、携程、艺龙、美团、百度、腾讯、阿里巴巴、京东、今日头条、唯品支付。。。

  • github地址:
    https://github.com/YMFE/yapi
  • 示例站点:
    http://yapi.demo.qunar.com/
  • 文档:
    https://hellosean1025.github.io/yapi/
  • yapi简介:

YApi 是高效、易用、功能强大的 api 管理平台,旨在为开发、产品、测试人员提供更优雅的接口管理服务。可以帮助开发者轻松创建、发布、维护 API,YApi 还为用户提供了优秀的交互体验,开发人员只需利用平台提供的接口数据写入工具以及简单的点击操作就可以实现接口的管理

开源可视化接口管理平台-YApi_第2张图片
  • 特性
    • 基于 Json5 和 Mockjs 定义接口返回数据的结构和文档,效率提升多倍
    • 扁平化权限设计,即保证了大型企业级项目的管理,又保证了易用性
    • 类似 postman 的接口调试
    • 自动化测试, 支持对 Response 断言
    • MockServer 除支持普通的随机 mock 外,还增加了 Mock 期望功能,根据设置的请求过滤规则,返回期望数据
    • 支持 postman, har, swagger 数据导入
    • 免费开源,内网部署,信息再也不怕泄露了

  • 下面就介绍下YAPI接口平台在docker容器下的部署
    docker安装流程见博客https://www.jianshu.com/p/fe438fac7cff
    • 拉取mongo 的镜像源
docker pull mongo
  • 查看拉取的docker镜像
[root@bogon webapps]# docker images
REPOSITORY                                    TAG                 IMAGE ID            CREATED             SIZE
mongo                                         latest              bcef5fd2979d        10 days ago         386MB
tomcat                                        latest              b56d8850aed5        3 weeks ago         529MB
nginx                                         latest              2073e0bcb60e        4 weeks ago         127MB
centos                                        latest              589dc4d40385        6 weeks ago         237MB
registry.cn-hangzhou.aliyuncs.com/anoy/yapi   latest              76d11bb7c386        2 months ago        170MB
  • 创建 MongoDB 数据卷
[root@bogon webapps]# docker volume create mongo_data_yapi
mongo_data_yapi
  • 启动 MongoDB
[root@bogon webapps]# docker run -d --name mongo-yapi -v mongo_data_yapi:/data/db mongo
3a11f1ca4af21ba1e485b6a3c6e4cc9818b49c30af0e51f9ea38da90a7ab42fd
[root@bogon webapps]# docker pull registry.cn-hangzhou.aliyuncs.com/anoy/yapi
Using default tag: latest
latest: Pulling from anoy/yapi
Digest: sha256:a34daaf6cf64c55fb849d92452009ff312636c05365cf02965f6871b8fbff0c5
Status: Image is up to date for registry.cn-hangzhou.aliyuncs.com/anoy/yapi:latest
registry.cn-hangzhou.aliyuncs.com/anoy/yapi:latest
  • 获取 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 6006:3000  registry.cn-hangzhou.aliyuncs.com/anoy/yapi  server/app.js


> [email protected] install-server /api/vendors
>  node server/install.js

log: mongodb load success...
初始化管理员账号成功,账号名:"[email protected]",密码:"ymfe.org"
  • 启动后会提示初始化账号密码,使用提示账目密码登录。本地打开设置的URL:http://192.168.1.90:6006,登录页面如下:


    开源可视化接口管理平台-YApi_第3张图片

  • 插件下载

    开源可视化接口管理平台-YApi_第4张图片
  • 上图功能需要安装cross-request 插件才能正常使用(关注下方二维码回复:【cross-request】 即可获得插件连接)

  • 插件安装步骤:

    1.提取连接插件,解压文件。

    2.打开chrome浏览器>右上角点击:更多工具>找到:扩展程序>点击:加载已解压的扩展程序。即可成功安装。截图如下:

开源可视化接口管理平台-YApi_第5张图片
  • 其它Chrome插件-JSONview插件、web前端助手插件连接,关注下方公众号均可获得:

  • 插件安装步骤同上

  • 测试结果如下:

开源可视化接口管理平台-YApi_第6张图片

更多测试技术分享、学习资源以及一些其他福利可关注公众号:【Coding测试】获取:

开源可视化接口管理平台-YApi_第7张图片
Coding测试

你可能感兴趣的:(开源可视化接口管理平台-YApi)