Yapi easyapi文件管理平台安裝與使用

2021-10-13 15:21:06 字數 1963 閱讀 9302

我正在建設乙個租房平台,進行基於租房業務的架構實踐。我嘗試著按照不同領域建立了幾個微服務,寫了一些介面,準備模擬真正的it企業開發環境,但是介面多了難免有變更,維護成本,目前乙個人的話維護介面文件確實很費時間,無法投入到更多架構,服務設計落地上。因此需要有乙個文件管理平台,來管理不同微服務的介面描述,便於後面多人開發的時候提供基礎文件。

當時遇到介面文件管理瓶頸之後,想著可以借用之前自己搗鼓的文件管理工具**進行繼續開發和迭代,但是也無異於從頭搞一套文件管理工具,因此自研的成本也比較高,為了快速輔助業務開發,自研的道路行不通。

在調研的時候也發現市面上開源的介面文件管理工具有很多,因此更加堅定了使用開源產品的念頭,在尋找開源平台的時候也做了一些評估,比如輕量級,可二次開發,可以快熟上手,與業務工程松耦合,不侵入業務**等等。經過一些調研發現有很多不錯的產品比如smartdoc,yapi,swagger,而且都有大規模使用。綜合評估下決定還是使用yapi吧,簡單來說逃脫不了真香定律,但是yapi的文件管理適合企業級開發應用,同時適合多團隊專案使用,便於介面管理,另外也調研了基於yapi的一些工具生態,整合外掛程式等,這些做的都比較好。因此,yapi便是我首要調研落地使用的開源產品。

要想使用yapi並不是沒有成本的,在部署之前我們需要了解一下yapi的依賴環境,首先需要安裝node.js,另外yapi的文件管理基於mongodb,因此這裡也需要先安裝mongodb。在跟其他文件管理工具比較的時候yapi的乙個明顯的缺點就是比較重,需要更多的基礎設施。

在install裡面新建目錄etc,e:\programfiles\softtools\mongodb\install\etc

新建配置檔案mongodb.conf,內容如下:

dbpath=e:\programfiles\softtools\mongodb\install\data #資料庫路徑

logpath=e:\programfiles\softtools\mongodb\install\logs\mongodb.log #日誌輸出檔案路徑

journal=true #啟用日誌檔案,預設啟用

cmd進入install資料夾下的bin目錄,執行命令:

mongod --config e:\programfiles\softtools\mongodb\install\etc\mongodb.conf
上述命令是啟動mongodb服務的命令,安裝部落格鏈結中的mongo命令,類似於客戶端訪問,這裡要區分開。執行命令之後訪問http://localhost:27017,判斷是否啟動成功。

基於windows平台的話,其實也很簡單,參考上面文件中的命令列部署即可。

安裝方式跟其他idea外掛程式類似,,這裡參考官方文件即可。

進入vendor目錄,啟動yapi伺服器,如下圖:

進行專案配置,yapi需要配置使用者名稱,密碼,由於啟動依賴mongodb,因此需要先啟動mongodb。配置完成第二次啟動則可以通過下面的命令啟動yapi:

這裡進入e:\programfiles\softtools\yapi\my-yapi目錄下執行命令

啟動成功之後如下圖:

這裡說明一下,yapi的介面文件是以專案為維度的,所以跟springboot的微服務工程是一致的,因此口徑上不太一致,建立專案之後,就可以手動維護介面了,這裡通過easyyapi的配置自動匯出。每個yapi的專案中有個token欄位,需要通過easyyapi-idea外掛程式配置一下這裡簡要說明一下,如下圖是我建立的**域專案,token是一串字串:

配置完成之後就可以愉快的進行介面api管理了~

知識管理 內容管理 文件管理 專案文件管理

事情的起因有點偶然,阿杜和我聊起系統的時候,說我們的系統現在開發的還可以,就暢想了一下能否有乙個桌面文件管理系統,問起原因,主要是感覺很多人不會管理自己的硬碟,不會管理自己的文件。我聽了也是感覺一振奮。但總還是感覺這個太大了,而且規則太過於複雜,複雜到你都不能設想有什麼規則。於是我聯絡其小董曾經的文...

專案文件管理

專案文件管理 project documents management 隱藏 編輯 專案文件管理,是指在乙個系統 軟體 專案開發程序中將提交的文件進行收集管理的過程。通常,文件管理在專案開發中不是很受重視,當發現其重要 性時,往往為時已晚。整個專案可能因此變得管理 昆亂,問題產生後無據可查。文件管理...

文件管理系統

馬永佔,myz,mayongzhan 發布乙個文件共享平台,多層許可權,針對不同的文件,進行時間 專案 部門歸類,版本的控制,推出一套標準化的文件格式。有利於專案交接,部門間溝通,核心員工對專案的總體控制,避免不同文件人員間習慣不同造成的不適應。整個平台由 許可權管理,使用者管理,文件管理,版本控制...