天天看點

apidoc 接口文檔系統

代碼未動,文檔先行。apidoc可以友善地維護接口文檔、模拟響應資料、前後端分離、導出PDF文檔。

特性說明

  • 可視化編輯:支援表單界面編輯接口,不必手動編輯swagger.json
  • 接口模拟響應:支援js動态生成模拟響應,實作前後端分離開發(背景還沒有@Controller、@ApiOperation等)
  • 動态預覽及調試:接口修改後預覽頁面實時重新整理,開啟模拟時可以直接調試調用
  • 導出PDF文檔:預覽頁面有“離線文檔MD”菜單,安裝writage插件可以手動導出PDF文檔(有書簽)

模拟響應資料

  • 每個接口都可以配置模拟響應資料,mock=true開啟模拟功能,增加了knife4j-front擴充界面
  • 接口可以配置靜态響應資料,請求置空表示比對所有請求,響應配置json字元串即可
  • 接口還可以配置動态資料,使用js生成響應對象,最後以json格式傳回前端

項目開源位址:gitee,歡迎圍觀。

apidoc 接口文檔系統