【API編寫】介紹一個國內強大的API接口文檔寫作網站showdoc


這幾天要寫一個接口API文檔,經理給我發過來一個,說要弄一個這樣的接口文檔,我一看,這可麻煩呀,有大綱有詳細,我以為要用div+css去一個頁面一個頁面做呢,這工作量可不小,網站一搜索,竟然有可以直接生成api接口文檔的網站,我又孤陋寡聞了,通過這幾天的使用比較,我選定了showodc。 

SHOWDOC

我本來用的apiary.io,全體也不錯,而且是oralce收購的,發展應該可以,但是國外的服務器國內訪問實在。。。。后來說在國內找一下,很幸運我發現了showdoc。

 

showdoc網站打開看着不起眼,但里面的內容相當的強大,重點說下特點

1:支持markdown語法(所有的api接口寫作現在都支持這個吧,因為他現在太方便了)

2:支持多用戶協作,你可以在項目下面隨意添加多個用戶一起完成api文檔的寫作。

3:可以分享並導出項目,生成需要的文檔格式如doc,可以離線瀏覽

4:支持響應式,手機電腦同樣精彩

5:支持項目轉讓

6:支持模版插入

7:支持歷史版本,你可以把操作恢復到以前的版本。

8:showdoc完全開源

9:可以部署到自己的服務器

10:如果在線使用,可以設置自己的個性域名,也可以對文檔進行加密,瀏覽者需要密碼才能訪問

11:可以通過一個在線測試api的工具,直接生成markdown,你幾乎不用寫代碼就能過所有的參數自動生成

看一些頁面:

 

如果你正在找快點試試吧

www.showdoc.cc


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM