YApi 可视化接口管理平台

• https://github.com/YMFE/yapiYapi源码

• yapi.demo.qunar.com YApi Demo（[email protected] / qq123456 )

• https://www.jianshu.com/p/a97d2efb23c5( 安装 & 升级 & 使用说明 )

• 安装（docker方式安装）

  • 前言介绍
    • 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，官方自定义配置文件 (https://github.com/YMFE/yapi/blob/master/config_example.json?spm=5176.1972344.1.6.LYdCBe&file=config_example.json )
      • vi config.json
        • {
          • "port": "3000",
          • "adminAccount": "[email protected]",
          • "db": {
          • "servername": "127.0.0.1",
          • "DATABASE": "yapi",
          • "port": 27017,
          • "user": "test1",
          • "pass": "test1",
          • "authSource": ""
        • },
          • "mail": {
          • "enable": true,
          • "host": "smtp.163.com",
          • "port": 465,
          • "from": "***@163.com",
          • "auth": {
          • "user": "***@163.com",
          • "pass": "*****"
        • }
        • }
        • }
    • 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 登录账号 [email protected]，密码 ymfe.org

        

        image
        

        image

• Yapi 官方文档

  • https://yapi.ymfe.org/documents/index.html

• 其他相关操作

  • 关闭 Yapi
    • docker stop yapi
  • 启动 Yapi
    • docker start yapi
  • 升级 Yapi

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

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

    • 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