易文檔,鏈接:https://easydoc.top,專(zhuān)業(yè)編寫(xiě)API文檔的工具,支持HTTP文檔,markdown文檔,富文本文檔
還支持在線(xiàn)接口測(cè)試,一鍵生成mock配置,前端不用等服務(wù)端開(kāi)發(fā)完接口就能進(jìn)行測(cè)試了。
不管是編寫(xiě)體驗(yàn)還是預(yù)覽,專(zhuān)業(yè)性和美觀(guān)性都會(huì)大大超越其他同類(lèi)產(chǎn)品

首頁(yè)
看下他的預(yù)覽效果,示例項(xiàng)目

接口預(yù)覽效果
市面很多http接口文檔的編寫(xiě)都是直接寫(xiě)markdown文檔,這種編寫(xiě)起來(lái)特別麻煩。易文檔在http文檔方面有做專(zhuān)門(mén)的處理,做了很多優(yōu)化體驗(yàn),比如按tab就可以自動(dòng)下一個(gè)輸入框,可以保存一些常用的參數(shù),方便快速引用進(jìn)來(lái),還有不限層次的子參數(shù),參數(shù)行順序調(diào)整。

專(zhuān)業(yè)的HTTP編輯器
特別強(qiáng)大的是,他的http文檔可以自定義參數(shù)塊和描述塊,比如失敗和成功返回的參數(shù)不一樣,我們可以添加兩個(gè)參數(shù)塊,分別對(duì)應(yīng)成功響應(yīng)參數(shù)、失敗響應(yīng)參數(shù)

靈活自定義
如果你想給每個(gè)返回都提供一個(gè)示例或者說(shuō)明,也都沒(méi)問(wèn)題,可以自己添加描述塊。而且塊的順序是可以調(diào)整的,非常方便。

更多使用技巧,請(qǐng)查看?必備使用技巧