YApi 可視化接口管理平臺 內網部署小計

• 前言

  • 之前仍是根據後臺的swagger手寫mock數據，被本身蠢哭~，最近有點時間了， 就研究了下能不能動態的去弄這些mock數據，以後就找到了yapi，感受大佬就是牛逼哈
  • 官網說有docker部署的方式，我試了， 一直不行，因此就用了比較蠢的方法，手動安裝各類環境 😃
  • 差很少就這樣了，平常bb結束
  • yapi官網
  • 感謝去哪兒前端團隊的開源，大佬

• 大綱

  • 內網部署
  • yapi 和swagger 的結合使用

• 內網部署

  • 官網說明

  • Windows 手動安裝 MongoDB

    • 環境要求

    • 安裝步驟

      • 訪問 https://www.mongodb.com/try/download/community
      • 打開安裝包開搞😃
      • 選擇安裝位置
      • 耐心等待，中途會要個權限，給他就是了
      • 安裝完畢

    • 建立數據庫和帳戶，建立一個新的數據庫給yapi部署使用（其實能夠不用作這一步，我在linux部署的時候就沒搞，照樣跑得起來 哈哈）

      • 點開這個文件

      • 查看全部的數據庫

        • show dbs
      • use [數據庫名稱] 有就直接切換，沒有就給你建立一個

      • 查看當前數據庫

        • db

      • 刪除某個數據庫

        • use [要刪除的數據庫]
        • db.dropDatabase()

      • 建立一個數據庫管理員帳戶

        • db.createUser({user: "admin",pwd: "123456",roles: [ { role: "userAdminAnyDatabase", db: "admin"}]})

    • 數據庫工具：

      • Navicat Premium 15 永久破解激活

  • Linux環境搭建

    • 環境準備

      • 查看系統命令：cat /proc/version
      • 我本機的版本：Linux version 2.6.32-696.el6.x86_64 (mockbuild@c1bm.rdu2.centos.org) (gcc version 4.4.7 20120313 (Red Hat 4.4.7-18) (GCC) ) #1 SMP Tue Mar 21 19:29:05 UTC 2017
      • 操做系統：centos 7
      • nodejs>7.6
      • mongodb>2.6
      • git

    • 安裝nodejs

      • 1. 獲取資源（部署nodejs儘量選擇偶數版本，由於偶數版本官方有較長的維護時間，故此次選擇8.x。）隨便裝， 我裝的是10的版本

        • curl -sL https://rpm.nodesource.com/setup_8.x | bash -
      • 1. 安裝
        • yum install -y nodejs
      • 1. 查看版本
        • node -v
      • 1. 查看npm版本
        • npm -v

    • 安裝mongodb

      • 1. 更新yum源，非必須可是更新一下無害
        • yum -y update
      • 1. 添加mongodb源文件，在/etc/yum.repos.d 建立一個 mongodb-org.repo 文件
        • touch /etc/yum.repos.d/mongodb-org.repo
      • 1. 編輯mongodb-org.repo文件
        • vim /etc/yum.repos.d/mongodb-org.repo
      • 1. 添加文件內容
        • 要這種形式的，幕布不支持Markdown 噁心哦
        • [mongodb-org]
        • name=MongoDB Repository
        • baseurl=http://mirrors.aliyun.com/mongodb/yum/redhat/7Server/mongodb-org/3.2/x86_64/
        • gpgcheck=0
        • enabled=1
        • 若是你也是在第四步卡了，沒法繼續安裝，能夠參考

        • https://stackoverflow.com/questions/34725574/yum-install-mongodb-3-2-fails 我用了下圖的方式 搞定

          • 1. 更改源

            • [mongodb-org-3.6]
            • name=MongoDB Repository
            • baseurl=[https://repo.mongodb.org/yum/...$releasever/mongodb-org/3.6/x86\_64/](https://repo.mongodb.org/yum/redhat/$releasever/mongodb-org/3.6/x86_64/)
            • gpgcheck=1
            • enabled=1
            • gpgkey=https://www.mongodb.org/static/pgp/server-3.6.asc

          • 2. 從新安裝

            • sudo yum install -y mongodb-org
        • Error starting mongod. /var/run/mongodb/mongod.pid exists解決方案.
      • 1. 安裝mongodb
        • yum install -y mongodb-org
      • 1. 啓動mongodb
        • service mongod start
      • 1. 設置開機啓動
        • chkconfig mongod on
      • 1. 查找mongod.conf文件
        • ps -ax | grep mongod
        • 查詢mongodb的數據庫存放路徑
      • 1. 配置遠程訪問
        • 主要是爲了方便直接使用數據庫工具鏈接數據庫
        • vim/etc/mongod.conf

        • 重啓mongod

          • service mongod restart

    • 安裝git

      • 官方推薦，在內網部署的時候安裝git，能夠根據本身所需安裝

        • yum -y install git

  • 搭建YApi環境

    • 1. 準備環境搭建完成後，開始搭建YApi,安裝命令
      • npm install -g yapi-cli --registry https://registry.npm.taobao.org
      • yapi server

      • 實例截圖：
    • 1. 執行 yapi server 啓動可視化部署程序，瀏覽器打開提示窗口上的地址，非本地服務器，將0.0.0.0替換指定的域名或IP，進入部署頁面。例如：http://127.0.0.1:9090/
    • 看到這個提示說明已經部署成功了， 9090端口能夠關閉了
    • 提示說讓咱們切換到部署路徑，執行相關命令~

    • 執行相關命令，就能夠用了

      • node vendors/server/app.js
      • 訪問：http://127.0.0.1:3000/
      • 終於出來了， 美滋滋~

  • yapi服務管理

    • 利用pm2方便服務管理維護

      • npm install pm2 -g //安裝pm2
      • cd {項目目錄}
      • pm2 start "vendors/server/app.js" --name yapi //pm2管理yapi服務
      • pm2 info yapi //查看服務信息
      • pm2 stop yapi //中止服務
      • pm2 restart yapi //重啓服務

  • yapi 升級管理

    • 升級

      • 升級項目版本是很是容易的，而且不會影響已有的項目數據，只會同步 vendors 目錄下的源碼文件
      • cd {項目目錄}
      • yapi ls //查看版本號列表
      • yapi update //更新到最新版本
      • yapi update -v {Version} //更新到指定版本

• yapi 和swagger 的結合使用

  • 官網的說明，記得看看哈

    • https://hellosean1025.github.io/yapi/documents/project.html#%E9%85%8D%E7%BD%AE%E7%8E%AF%E5%A2%83

  • 建立一個項目項目

    • 註冊一個賬號
    • 建立一個項目

  • swagger的設置

    • 切換到swagger的同步設置
    • 找到後臺的地址： 輸入上面，而後點保存，以後就耐心等待2分鐘以後，yapi會自動同步
    • 若是出現這種錯誤，不用理會，多點兩下 他就會好了
    • 成功觸發yapi的同步任務
    • 成功同步過來，若是同步的不理想， 就把swagger的同步設置改爲所有覆蓋就行了

  • 集成到業務系統

    • 設置請求上下文

      • 找到上下文，配置mock數據， 把這個地址，放到反向代理的設置裏面去，就會有數據了
      • 這些值就都是yapi 幫咱們mock的數據了，開心~~不再用寫mock數據了，之前本身好蠢 😃

    • 接口頁面相關說明

    • 請求配置，自定義請求頭和返回值

      • 官方的說明

        • https://hellosean1025.github.io/yapi/documents/project.html#%E8%AF%B7%E6%B1%82%E9%85%8D%E7%BD%AE
      • 你能夠在這裏設置1.請求頭 2.根據不一樣狀態，返回不一樣的數據格式等

      • 設置請求頭

        • context.requestHeader.ergouzi=66666

      • 設置返回值

        • 官網說明

          • https://hellosean1025.github.io/yapi/documents/adv_mock.html#%E8%87%AA%E5%AE%9A%E4%B9%89-mock-%E8%84%9A%E6%9C%AC

        • 實際使用：默認全部接口都是ok的，咱們和後臺約定返回的數據格式是 {data:xxx,resultCode:xxx} 全部的數據都放在data 裏面，resultCode 爲1 表示請求成功

          • mockJson.resultCode=1
          • 設置生效， 以前的隨機數變成了1 搞定收攤

    • 接口 --- 編輯頁面介紹

      • 例子1：咱們發現咱們的年齡字段默認隨機是一個負數，其實和真實數據相差仍是很大的，咱們真實的世界裏面能活到100歲就很牛逼了，看看怎麼設置

        • 能夠直接點預覽看效果，以下想再業務系統裏面看效果，記得點保存按鈕，否則不生效！

      • 例子2： auditStatus 表示審覈狀態，審覈狀態會有不少個， 咱們想看多個審覈狀態怎麼搞呢

        • 設置
        • 效果
        • 他會在咱們剛纔的枚舉裏面，隨機取一個

    • 接口 --- 運行頁面介紹

      • cross-request 插件

        • 怎麼安裝請訪問
        • cross-request 被官方下架後的插件安裝方法

      • 添加環境

        • 添加你須要的環境並保存，以後就隨便調用了， cross-request 會幫你處理跨域，做者說只有https的在network纔看不到請求， 我http的也看不到，不知道什麼鬼

• 結束語

  • 本文若有錯誤，歡迎指正，很是感謝
  • 以爲有用的老鐵，點個雙擊，小紅心走一波
  • 歡迎灌水，來呀，互相傷害哈 o(∩_∩)o 哈哈

• 參考資料

  • Yapi官網
  • 從零開始搭建Yapi環境
  • 查看Linux內核版本的命令
  • 查詢mongodb的數據庫存放路徑
  • mongodb啓動報錯如何處理