接口文檔管理工具showDoc

隨着互聯網的發展，前後端分離已成爲互聯網項目開發的業界標準使用方式。

由此而產生的前端開發工程師和後端開發工程師的溝通效率問題。

推薦一個應此而生的文檔管理工具---showdoc

showdoc官網

一、介紹

1.ShowDoc是什麼

• 每當接手一個他人開發好的模塊或者項目，看着那些沒有寫註釋的代碼，我們都無比抓狂。文檔呢？！文檔呢？！Show me the doc ！！

• 程序員都很希望別人能寫技術文檔，而自己卻很不希望要寫文檔。因爲寫文檔需要花大量的時間去處理格式排版，想着新建的word文檔放在哪個目錄等各種非技術細節。

• word文檔零零散散地放在團隊不同人那裏，需要文檔的人基本靠吼，吼一聲然後上qq或者郵箱接收對方丟過來的文檔。這種溝通方式當然可以，只是效率不高。

• ShowDoc就是一個非常適合IT團隊的在線文檔分享工具，它可以加快團隊之間溝通的效率。

2.功能

• 權限管理

  • 公開項目與私密項目
    • ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登錄與非登錄的用戶訪問，而私密項目則需要輸入密碼驗證訪問。密碼由項目創建者設置。
  • 項目轉讓
    • 項目創建者可以自由地把項目轉讓給網站的其他用戶。
  • 項目成員
    • 你可以很方便地爲ShowDoc的項目添加、刪除項目成員。項目成員可以對項目進行編輯，但不可轉讓或刪除項目（只有項目創建者纔有權限）
  • 團隊管理
    • 利用showdoc的團隊功能你可以更好地進行團隊協作

• 編輯功能

  • markdown編輯

    • ShowDoc採用markdown編輯器，無論是編輯還是閱讀體驗都極佳很棒。如果你不瞭解Markdown，請在搜索引擎搜索”認識與入門 Markdown”

  • 模板插入

    • 在ShowDoc的編輯頁面，點擊編輯器上方的按鈕可方便地插入API接口模板和數據字典模板。插入模板後，剩下的就是改動數據了，省去了很多編輯的力氣。
  • 歷史版本
    • ShowDoc爲頁面提供歷史版本功能，你可以方便地把頁面恢復到之前的版本。

• 多平臺

  showdoc支持網頁版、手機app版和電腦客戶端版。客戶端地址可見：https://www.showdoc.cc/clients

 

二、示例

1.全局錯誤碼

2.接口文檔

 

3.api模板

4.接口調試