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

2021-01-15 碼聞強識

獨樂樂，不如眾樂樂.

之前單獨寫過一篇文章《介紹幾款常用的在線 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 年著手沉澱一些內容，內容聚焦於個人思考、閱讀、寫作、投資理財、技術提升等，順便你也可以在星球裡提問，我會竭盡所能回覆你，希望在未來為期一年的陪伴中，對你有所幫助。

Long-press QR code to transfer me a reward

你的認可，才是對我最大的鼓勵

As required by Apple's new policy, the Reward feature has been disabled on Weixin for iOS. You can still reward an Official Account by transferring money via QR code.

相關焦點

  • 文檔在線搜 4款在線文檔分享平臺大比拼
    所以，專業的在線文檔共享平臺應運而生，今天阿甘就對四款比較主流的在線文檔分享平臺進行一個對比，看看用哪一個查找資料更加方便。CPU： AMD Athlon II X3 435　　內存：DDR3 1333 2GB　　顯卡：ATI4850　　系統：Windows XP SP3　　網絡：電信2M ADSL　　評測對象：　　百度文庫：http://wenku.baidu.com/　　百度文庫是中國最大的搜尋引擎百度推出的在線文檔共享平臺
  • 告訴你各大在線文檔的真實體驗
    因此，Office Online在線文檔在國內無法做到時時「在線」。使用Office Online，往往和國外的團隊協作才能彰顯其價值。Google文檔在雲端辦公方面是個先行者，其設計也是相當激進的。在當初，Google文檔給筆者最大的印象就是這似乎只是一個調劑用的辦公工具，它實在是太輕巧了，甚至沒有一個客戶端，通過網頁就承接了傳統Office軟體的任務。用Google文檔工作，文件默認就保存在雲端，甚至讓筆者一度很沒有安全感。
  • 騰訊文檔電腦版_騰訊文檔電腦版官方版-太平洋下載中心
    【快捷登錄】qq/TIM/微信登錄：支持QQ/TIM/微信直接登錄，無需單獨註冊;文檔信息同步： QQ/TIM內的在線文檔信息，自動實時同步至騰訊文檔。【數據安全】權限控制：可自主設置查看及編輯權限，文檔安全盡在掌控;技術保障：雲端存儲加密技術為文檔安全保駕護航;版權保護：文檔支持展示水印，版權有保障。
  • 產品文檔小結:看似簡單的產品文檔,其實並不簡單
    雖然近來大家都對「又臭又長」文檔深惡痛絕，但是不可否認Word能力強好處多，不管是對版本控制、審閱批改、連結跳轉，還是對拓展文件的支持性來說，Word都可以很好的hold住。而且，多人協作還可以嘗試Google Docs嘛。當文檔變得「又臭又長」之後，只會被團隊束之高閣，喪失它應有的價值。
  • 翻譯狗:超實用的PDF翻譯工具,文檔翻譯神器!
    不管是看外文文獻，還是處理工作中的英文資料，都會遇到要翻譯PDF文檔的情況。平時我們用PDF傳輸資料的好處不用多說，但是一旦遇到需要翻譯的時候，缺點也很明顯：需要轉換格式、排版錯亂、圖表公式丟失…怎麼辦？
  • 職場新人N節課003 - 養成一個好的文檔規範
    特別是在一個團隊之中，任何人都不是孤立存在的，當我們要共同完成一個項目，編寫一個或一套文檔時，一個好的文檔規範顯得尤為重要。但以筆者在職場上這麼多年的經驗看過來，很多職場人的文檔規範其實並不好，甚至可以說沒有什麼規範，而造成這種現象的很大一個因素就是因為在初入職場時，沒有養成一個好的習慣。
  • 文檔下載神器
    很多自己需要的參考資料由於需要VIP才能下載或者閱覽，但是僅僅因為一篇文檔就充值VIP或者花大價錢去買授權，絕大部分時候都是不合算的。直接用搜尋引擎搜索，往往很難搜索到需要的免費的文檔，現在各個文庫下載門檻逐步提高的情況下，有一款好用的文檔下載工具用來應急，節約時間精力，變成了痛點。冰點文庫下載器便是一款在臨時有需求時，可以下載自己所需要的VIP文檔的神器。
  • 翻譯狗|刷文獻必備的翻譯工具,一鍵搞定PDF文檔翻譯
    然而翻譯外文文獻總是需要花費很多時間，很多專業性比較強的詞彙翻譯起來更是晦澀難懂，這時候就需要一款靠譜的翻譯工具，來幫助大家高效查閱文獻。那麼今天就給大家介紹一款PDF文檔翻譯工具——翻譯狗。翻譯狗基於神經網絡智能翻譯系統研發而成，是一款專業的PDF文檔翻譯工具，操作方式也很簡單，只用登陸翻譯狗官網，在首頁點擊【立即翻譯】即可。
  • 小米雲服務上線文檔在線編輯器:隨時保存歷史版本
    IT之家11月27日消息 小米官方宣布，網際網路時代下，丟失重要文檔，就像80年代丟了錢包一樣痛。為了解決丟失文檔的噩夢。小米雲服務上線新功能——文檔在線編輯器。IT之家獲悉，用戶可以一鍵同步線上文檔——在線編輯，隨時保存歷史版本（當前可支持保存近10次的文檔版本）。
  • kkFileView v2.1.0 發布,文件文檔在線預覽解決方案
    kkfileview文件在線預覽此項目為文件文檔在線預覽項目解決方案，項目使用流行的spring boot搭建，易上手和部署，部署好後可以獨立提供預覽服務，使用http接口訪問，不需要和應用集成
  • 如何在PDF文檔中添加圖章?
    有時候我們在日常工作或學習中，需要對一些內部文檔加上特定的文檔說明或專屬標記，該如何處理呢？對於PDF文檔我們可以使用添加圖章的方式來實現，一起來看看吧。一、添加固定的圖章首先用極速PDF編輯器打開我們需要添加圖章的文檔，點擊工具欄「圖章」右側下拉菜單「內置」，可直接選擇任意一個系統已製作的圖章，然後在需要添加圖章處單擊滑鼠即可添加。在已添加的圖章處，單擊滑鼠右鍵，選擇「屬性」在彈出的設置對話框，可對圖章進行樣式和透明度等外觀的更改。二、添加自定義圖章1.
  • 日常工作文檔的使用在企業微信這裡將更加便捷
    所以我們不能局限於企業微信只是個工作社交軟體，我們也要去將它本身自帶的OA功能去靈活的運用起來，那麼這次雲妹主要給大家介紹下咱們日常工作文檔在企業微信這裡如何更方便快捷的編輯和操作。企業微信關於文檔的處理有兩個，一個是微盤，用於收集儲存便於查找翻閱；另一個就是微文檔，微文檔顯示你共享雲盤-微盤的創建和瀏覽，在線文檔工具「微文檔」支持多人同時協作編輯同一個文檔，可讓所有人在線完成編輯，支持在文檔內容中@同事，支持邊寫邊聊，讓協同辦公變得更簡單。同時微文檔的訪問、修改、瀏覽記錄，也可以回溯和追蹤，讓敏感信息不外洩。
  • 為了美化文檔,常用藝術字進行修飾,那在文檔中如何插入呢?
    word是我們生活中很常用的一款文檔編輯工具，對它的一些簡單功能我們應該要了解。今天將介紹的就是word中很簡單的一個功能，word中實現藝術字的效果。Office中的藝術字結合了文本和圖形的特點，能夠使文本具有圖形的某些屬性，如設置旋轉、三維、映像等效果.用戶可以在Word2010文檔中插入藝術字。在文檔中插入藝術字：尋找幸福。操作步驟：（1）將光標移到插入藝術字的位置。（2）單擊「插入」標籤，在「文本」分組中單擊「藝術字」按鈕 ，選擇藝術字樣式，如選擇「填充-橙色」。
  • 如何實現PDF文檔的電子印章(一)
    在電子印章一文（密碼技術的典型應用——電子印章）中，介紹過不同文檔格式有不同的電子印章實現方式。實際上，Adobe在PDF標準中已經集成了電子籤名功能，今天就先學習一下如何在Adobe的PDF工具中，通過使用籤名功能實現PDF文檔的電子印章應用。
  • 產品經理必備14大效率工具
    文檔與表格協作工具產品經理可以通過在線文檔完成需要撰寫的工作，並通過雲端存儲的功能隨時隨地在線查看編輯。石墨文檔：團隊文檔和表格協作工具石墨是一款輕便、高效的在線文檔和表格協作工具，致力於成為下一代輕量版在線Office。支持多人實時協作編輯是石墨最大的亮點。產品經理不管是撰寫產品需求文檔，記錄靈感思路，還是與團隊成員在線協作辦公，都可以在石墨裡高效完成。
  • 金山文檔品牌新風口,探析「金小獴」搶佔的2億辦公用戶心智
    擬人化IP打造是否成功與自身品牌價值貼合度密切相關，金山文檔的「金小獴」，是近期國內科技公司擬人化IP的又一次成功嘗試。金山文檔是金山辦公旗下主打多人協作的在線Office，產品面世只有2年的時間。相比以端主打、眾所周知的WPS，作為「隔世代」的小弟，金山文檔從初創開始就走上了新鮮感十足的品牌傳播道路。
  • 怎樣修改PDF文檔中的文字顏色?
    極速PDF編輯器是我們常用的一款PDF文檔專用編輯軟體，它的功能很齊全，但是有一些工具的使用方法可能很多人並不清楚，比如如何修改PDF文本中的字體顏色呢？下面一起來看看具體操作方法吧。首先用極速PDF編輯器打開PDF文檔後，選擇工具欄的「文本工具」即可在文檔中選中需要修改的文字部分。接著點擊工具欄的「對象填充」工具，即可開始修改文本的顏色。
  • 搜狗翻譯App上線文檔翻譯功能
    近日，搜狗翻譯App上線「文檔翻譯」功能，支持大篇幅Word或PDF格式文檔在移動端的實時翻譯與存儲，進一步提升了用戶移動翻譯體驗。據了解，搜狗翻譯App是第一個免費支持「文檔翻譯」的綜合類翻譯應用，目前可支持中英、中日、中韓三個語種間的文檔快速互譯。
  • 架構師技術文檔:Redis+Nginx+Spring全家桶+Dubbo精選
    最近花了很長的時間去搜羅整理Java核心技術好文，我把每個Java核心技術的優選文章都整理成了一個又一個的文檔。今天就把這些東西分享給老鐵們，也能為老鐵們省去不少麻煩，想學什麼技能了，遇到哪方面的問題了 直接打開文檔學一學就好了。不多說，直接上乾貨！
  • 多個Word文檔總頁數的快速統計技巧
    如果用Word來編寫一本書，許多朋友習慣將每一章分別存為一個單獨的文件。當全書完成時，通常會需要統計一下全書的頁數。一個一個地將文件打開查看頁數並加起來，顯然比較麻煩。本文將介紹一種實用的Word技巧，無需打開所有文件，只使用Windows的資源管理器即可輕鬆查看Word文檔的頁數，然後將其相加即可。