易文檔砾嫉,鏈接:https://easydoc.top,專業(yè)編寫API文檔的工具窒篱,支持HTTP文檔焕刮,markdown文檔,富文本文檔
還支持在線接口測試墙杯,一鍵生成mock配置配并,前端不用等服務(wù)端開發(fā)完接口就能進行測試了。
不管是編寫體驗還是預(yù)覽高镐,專業(yè)性和美觀性都會大大超越其他同類產(chǎn)品
看下他的預(yù)覽效果溉旋,示例項目
市面很多http接口文檔的編寫都是直接寫markdown文檔,這種編寫起來特別麻煩嫉髓。易文檔在http文檔方面有做專門的處理观腊,做了很多優(yōu)化體驗,比如按tab就可以自動下一個輸入框算行,可以保存一些常用的參數(shù)梧油,方便快速引用進來,還有不限層次的子參數(shù)州邢,參數(shù)行順序調(diào)整儡陨。
特別強大的是,他的http文檔可以自定義參數(shù)塊和描述塊偷霉,比如失敗和成功返回的參數(shù)不一樣迄委,我們可以添加兩個參數(shù)塊,分別對應(yīng)成功響應(yīng)參數(shù)类少、失敗響應(yīng)參數(shù)
如果你想給每個返回都提供一個示例或者說明叙身,也都沒問題,可以自己添加描述塊硫狞。而且塊的順序是可以調(diào)整的信轿,非常方便晃痴。
更多使用技巧,請查看?必備使用技巧