易文檔,鏈接:https://easydoc.top,專業編寫API文檔的工具,支持HTTP文檔,markdown文檔,富文本文檔
還支持在線接口測試,一鍵生成mock配置,前端不用等服務端開發完接口就能進行測試了。
不管是編寫體驗還是預覽,專業性和美觀性都會大大超越其他同類產品
首頁
看下他的預覽效果,示例項目
接口預覽效果
市面很多http接口文檔的編寫都是直接寫markdown文檔,這種編寫起來特別麻煩。易文檔在http文檔方面有做專門的處理,做了很多優化體驗,比如按tab就可以自動下一個輸入框,可以保存一些常用的參數,方便快速引用進來,還有不限層次的子參數,參數行順序調整。
專業的HTTP編輯器
特別強大的是,他的http文檔可以自定義參數塊和描述塊,比如失敗和成功返回的參數不一樣,我們可以添加兩個參數塊,分別對應成功響應參數、失敗響應參數
靈活自定義
如果你想給每個返回都提供一個示例或者說明,也都沒問題,可以自己添加描述塊。而且塊的順序是可以調整的,非常方便。
更多使用技巧,請查看?必備使用技巧