showdoc 功能
1、編輯功能
(1)markdown編輯
ShowDoc采用markdown編輯器,無論是編輯還是閱讀體驗都極佳很棒。如果你不了解Markdown,請在搜索引擎搜索”認(rèn)識與入門 Markdown”
(2)模板插入
在ShowDoc的編輯頁面,點擊編輯器上方的按鈕可方便地插入API接口模板和數(shù)據(jù)字典模板。插入模板后,剩下的就是改動數(shù)據(jù)了,省去了很多編輯的力氣。
(3)歷史版本
ShowDoc為頁面提供歷史版本功能,你可以方便地把頁面恢復(fù)到之前的版本。
2、分享與導(dǎo)出響應(yīng)式網(wǎng)頁設(shè)計,可將項目文檔分享到電腦或移動設(shè)備查看。同時也可以將項目導(dǎo)出成word文件,以便離線瀏覽。
3、權(quán)限管理
(1)公開項目與私密項目
ShowDoc上的項目有公開項目和私密項目兩種。公開項目可供任何登錄與非登錄的用戶訪問,而私密項目則需要輸入密碼驗證訪問。密碼由項目創(chuàng)建者設(shè)置。
(2)項目轉(zhuǎn)讓
項目創(chuàng)建者可以自由地把項目轉(zhuǎn)讓給網(wǎng)站的其他用戶。
(3)項目成員
你可以很方便地為ShowDoc的項目添加、刪除項目成員。項目成員可以對項目進(jìn)行編輯,但不可轉(zhuǎn)讓或刪除項目(只有項目創(chuàng)建者才有權(quán)限)
(4)團(tuán)隊管理
你可以自行添加多個團(tuán)隊,為團(tuán)隊分配不同的項目,同時設(shè)置團(tuán)隊里每個人的權(quán)限。
showdoc特點
1、API文檔
伴隨著移動互聯(lián)的發(fā)展趨勢,BaaS(后端開發(fā)即服務(wù)項目)愈來愈流行。服務(wù)器端出示API,APP端或是網(wǎng)頁頁面前端開發(fā)便可便捷啟用數(shù)據(jù)信息。用ShowDoc能夠 十分便捷迅速地編寫出美觀大方的API文檔,另外還將適用從編碼文檔中自動生成API文檔
2、數(shù)據(jù)字典
一份好的數(shù)據(jù)字典能夠 很便捷地為他人表明你的數(shù)據(jù)庫查詢構(gòu)造,如每個字段名的釋意等。
3、表明文檔
你徹底能夠 應(yīng)用showdoc來編寫一些專用工具的使用說明,還可以編寫一些技術(shù)標(biāo)準(zhǔn)表明文檔以供精英團(tuán)隊查看。
以上便是winwin7小編給大家介紹的API文檔編輯工具showdoc!