一個非常適合IT團隊的在線API文檔、技術文檔工具

• 2020 年 2 月 14 日
• 筆記

獨樂樂，不如眾樂樂. 之前單獨寫過一篇文章《介紹幾款常用的在線 API 管理工具》，今天又發現個不錯的工具，推薦給大家。

ShowDoc

每當接手一個別人開發好的模組或者項目，看著那些沒有寫注釋的程式碼，文檔呢？！文檔呢？！Show me the doc ！！

你很希望別人能寫技術文檔，而自己卻很不希望要寫文檔。即使有文檔，也是零零散散地放在團隊不同人手裡，到硬碟里搜一波，用 QQ 、郵箱直接丟，這種溝通當然可以，只是效率不高。

ShowDoc 是款適合 IT 團隊的在線文檔分享工具，可以讓團隊之間更高效的溝通。

題圖 from pixabay

API 在線文檔

APP、web 、Iot設備等前端與伺服器常用 API 來進行交互.

方便快速地編寫出美觀的 API 文檔，支援 MarkDown 語法.

數據結構、基礎字典

好的數據字典可以很方便地向別人描述你的資料庫結構.

用 ShowDoc 可以編輯出美觀的數據字典.

支援二次開發

工具是基於PHP+VUE的方式完成，可以根據需要進行訂製化開發.

許可權控制、團隊協作

團隊許可權管理機制讓團隊良好地協同編寫文檔.

關鍵是：免費的開源的

ShowDoc 提供免費開源的版本.

你可以選擇將 ShowDoc 部署到你的伺服器.

多種文檔支援

你完全可以使用 ShowDoc 來編寫一些工具的說明書.

也可以編寫一些技術規範說明文檔以供團隊查閱.

提供在線、私有部署兩種方式

www.showdoc.cc 提供安全穩定的在線文檔託管服務.

你可以放心地選擇託管你的文檔數據在雲端.

手機 App 支援

提供 iOS 與 Android 兩個版本，提供私有部署版地址綁定。

在線測試 API

提供RunApi功能支援 post/get 常用的 http 請求方式，可以添加 URL 請求參數，也可以自定義 header.

上幾張截圖，看看效果：

我申請了一個知識星球，2020 年著手沉澱一些內容，內容聚焦於個人思考、閱讀、寫作、投資理財、技術提升等，順便你也可以在星球里提問，我會竭盡所能回復你，希望在未來為期一年的陪伴中，對你有所幫助。