apidoc 生成swagger接口文档

原创
03/04 10:51
阅读数 818

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项目加入扩展功能。

展开阅读全文
打赏
0
0 收藏
分享
打赏
0 评论
0 收藏
0
分享
返回顶部
顶部