apidoc 生成swagger接口文檔


apidoc支持外部接口jsonUrl生成接口文檔,支持html和markdown兩種格式,可以使用Word轉換為doc和pdf文檔。

  1. 獲取swagger.json上傳得到jsonUrl
    image_thumb[1] image_thumb[3]
    表單上傳:選擇文件,點擊異步,復制預覽鏈接
  2. swagger2html,生成html接口文檔
    image_thumb[5] image_thumb[7]
    此工具支持jsonFile上傳,可選上傳使用jsonUrl。另存為html頁面,使用Word或WPS可以轉為doc、pdf文檔。
  3. swagger2md,生成markdown接口文檔

    image_thumb[11]
    文檔管理,離線文檔MD,下載保存。Word需要安裝Writage插件,即可轉換為doc、pdf文檔。


生成接口文檔的邏輯,是用數據io.swagger.models.Swagger渲染freemarker等模板頁面,想要支持其他更多的模板,可以到apidoc項目加入擴展功能。


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM