代碼未動,文檔先行。apidoc可以方便地維護接口文檔、模擬響應數據、前后端分離、導出PDF文檔。
特性說明
- 可視化編輯:支持表單界面編輯接口,不必手動編輯swagger.json
- 接口模擬響應:支持js動態生成模擬響應,實現前后端分離開發(后台還沒有@Controller、@ApiOperation等)
- 動態預覽及調試:接口修改后預覽頁面實時刷新,開啟模擬時可以直接調試調用
- 導出PDF文檔:預覽頁面有“離線文檔MD”菜單,安裝writage插件可以手動導出PDF文檔(有書簽)
模擬響應數據
- 每個接口都可以配置模擬響應數據,mock=true開啟模擬功能,增加了knife4j-front擴展界面
- 接口可以配置靜態響應數據,請求置空表示匹配所有請求,響應配置json字符串即可
- 接口還可以配置動態數據,使用js生成響應對象,最后以json格式返回前端
項目開源地址:gitee,歡迎圍觀。