apidoc支持外部接口jsonUrl生成接口文檔,支持html和markdown兩種格式,可以使用Word轉換為doc和pdf文檔。
- 獲取swagger.json,上傳得到jsonUrl
表單上傳:選擇文件,點擊異步,復制預覽鏈接 - swagger2html,生成html接口文檔
此工具支持jsonFile上傳,可選上傳使用jsonUrl。另存為html頁面,使用Word或WPS可以轉為doc、pdf文檔。 - swagger2md,生成markdown接口文檔
文檔管理,離線文檔MD,下載保存。Word需要安裝Writage插件,即可轉換為doc、pdf文檔。
生成接口文檔的邏輯,是用數據io.swagger.models.Swagger渲染freemarker等模板頁面,想要支持其他更多的模板,可以到apidoc項目加入擴展功能。