解救開發人員寫文檔的痛苦

開發人員的痛苦

接手前人的項目，沒有接口文檔，只能看代碼學習

接口文檔用txt、word、markdown寫，編寫特別麻煩，寫出來的文檔也不美觀。

多層級的參數（子參數），寫起來麻煩，不知道怎麼表達更好。

有的文檔須要圖文並茂，須要代碼示例，須要測試用例，須要提供mock ...

經常使用參數須要重複寫不少次，沒有快速的引用的功能

寫完接口，還須要本身寫代碼測試接口是否正確

前端須要等待服務端把接口寫完後，才能進行聯調開發

解決方案

使用專業的接口管理工具：易文檔，集合API文檔管理，接口在線測試，一鍵生成mock配置，測試用例

支持http、tcp、markdown、富文本多種文檔格式

專門爲http文檔準備的編輯器，編寫方便快速，不須要動鼠標，寫完一個 tab 一下就下一個，全鍵盤操做

支持經常使用參數快捷引用，再也不作無聊的重複工做；

支持預約義域名，快速切換測試服，正式服。

支持參數行順序調整，拖動就能調整

能夠隨意增長 /刪除參數塊，好比我不須要頭部參數，我能夠刪除；我能夠添加成功時返回什麼參數，失敗時又返回什麼參數

能夠自定義說明，好比我想在請求參數後面添加一個特別說明，或者示例，我能夠隨時增減，而且隨時調整順序

能夠在線測試接口，測試完還能夠把調用結果保存爲測試用例，方便他人查看和快速引用

漂亮專業的預覽頁，點擊就能自動複製 url，參數名等

文檔列表能夠進行分類，調整順序，搜索

能夠隨時分享文檔給朋友，能夠設置密碼、失效時間