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