ShowDoc v2.10.0 釋出, IT 團隊的線上 API 文件、技術文件工具

star7th發表於2022-01-10

更新內容:

1 ,安全更新

2 ,增加頁面修改提醒功能,可通知指定的專案成員

3 ,增加專案變更記錄功能(檢視入口在專案主頁的右側工具欄的更多展開按鈕中)

4 ,可以匯入檔案(postman/swagger/markdown 壓縮包)到已存在的專案內,也可以重複匯入以覆蓋更新

5 ,優化註釋生成文件功能

6 ,支援通過 s3 協議上傳附件

更之前的一些版本更新彙總

1 ,修復匯入 swagger 檔案的問題

2 ,修復點選檔案庫錯誤的問題

3 ,支援 runapi 客戶端的錯誤返回示例

4 ,支援 runapi 客戶端的搜尋功能

5 ,支援 runapi 客戶端的 query 和路徑變數功能

6 ,可一鍵設定團隊的成員專案許可權為只讀

7 ,選擇目錄時候可輸入關鍵字搜尋目錄

8 ,在編輯頁面時候可跳轉去新建目錄

9 ,完善頁面排序功能

10 ,修復 xss 安全漏洞

11 ,解決 TOC 目錄遮擋圖示的問題

12 ,支援 runapi 客戶端的介面狀態功能

13 ,支援 runapi 客戶端的全域性 cookies 功能

14 ,支援 runapi 客戶端的全域性指令碼功能

如何操作

更新步驟請參考請參考手冊的升級安裝部分: https://www.showdoc.com.cn/help?page_id=13732

介紹

ShowDoc 是一個非常適合 IT 團隊的線上 API 文件、技術文件工具,既有開箱即用的線上託管服務版,也有免費的開源版( github 1 萬+ star )。通過 showdoc ,你可以方便地使用 markdown 語法來書寫出美觀的 API 文件、資料字典文件、技術文件、線上 excel 文件等等。如果不想編輯 markdown 文件,你還可以利用 showdoc 的自動化能力,從程式註釋中自動生成 API 文件,或者從搭配的 RunApi 客戶端(類似 postman 的 api 除錯工具)中一邊除錯介面、一邊自動生成文件。無需手動編寫文件,釋放生產力。通過分配專案成員和團隊成員,你可以很方便地進行專案文件的許可權管理和團隊協作,也可以分享文件出去給朋友檢視。ShowDoc 還支援多平臺客戶端,有 win 客戶端、mac 客戶端、ios 、android 等,更方便跨平臺使用。目前超過 100000+的網際網路團隊正在使用 showdoc ,包括知名公司內部的一些團隊,比如騰訊、華為、百度、京東、位元組跳動等等。

關於 Showdoc 的詳細介紹,請看: https://www.showdoc.com.cn/help

本作品採用《CC 協議》,轉載必須註明作者和本文連結

相關文章