https://github.com/YMFE/yapiYapi源碼

yapi.demo.qunar.com YApi Demo（406834061@qq.com / qq123456 )

http://m.itdecent.cn/p/a97d2efb23c5( 安裝 & 升級 & 使用說明 )

安裝（docker方式安裝）

• 前言介紹
  • Yapi 由 YMFE 開源，旨在為開發(fā)、產(chǎn)品、測試人員提供更優(yōu)雅的接口管理服務(wù)，可以幫助開發(fā)者輕松創(chuàng)建、發(fā)布、維護(hù) API。
  • 權(quán)限管理
    • YApi 成熟的團(tuán)隊(duì)管理扁平化項(xiàng)目權(quán)限配置滿足各類企業(yè)的需求
  • 可視化接口管理
    • 基于 websocket 的多人協(xié)作接口編輯功能和類 postman 測試工具，讓多人協(xié)作成倍提升開發(fā)效率
  • Mock Server
    • 易用的 Mock Server，再也不用擔(dān)心 mock 數(shù)據(jù)的生成了
  • 自動(dòng)化測試
    • 完善的接口自動(dòng)化測試,保證數(shù)據(jù)的正確性
  • 數(shù)據(jù)導(dǎo)入
    • 支持導(dǎo)入 swagger, postman, har 數(shù)據(jù)格式，方便遷移舊項(xiàng)目
  • 插件機(jī)制
    • 強(qiáng)大的插件機(jī)制，滿足各類業(yè)務(wù)需求
  • 去哪兒網(wǎng)移動(dòng)架構(gòu)組（YMFE）是由FE，iOS和Android工程師共同組成的，去哪兒最具想象力、創(chuàng)造力和影響力的大前端團(tuán)隊(duì)。
• 使用 Docker 構(gòu)建 Yapi
  • 1、創(chuàng)建 MongoDB 數(shù)據(jù)卷
    • docker volume create mongo_data_yapi
  • 2、啟動(dòng) 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 數(shù)據(jù)庫索引及管理員賬號（一行一行輸入，\ 為換行符）
    • 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": "admin@admin.com",
        • "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、啟動(dòng) Yapi 服務(wù)
    • 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

      image
      image

Yapi 官方文檔

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

其他相關(guān)操作

• 關(guān)閉 Yapi
  • docker stop yapi
• 啟動(dòng) Yapi
  • docker start yapi
• 升級 Yapi

  • 1、停止并刪除舊版容器docker rm -f yapi

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

  • 3、啟動(dòng)新容器

    • 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