天天看点

apidoc 生成swagger接口文档

apidoc支持外部接口jsonUrl生成接口文档,支持html和markdown两种格式,可以使用Word转换为doc和pdf文档。

  1. 获取swagger.json,上传得到jsonUrl

    表单上传:选择文件,点击异步,复制预览链接

  2. swagger2html,生成html接口文档

    此工具支持jsonFile上传,可选上传使用jsonUrl。另存为html页面,使用Word或WPS可以转为doc、pdf文档。

  3. swagger2md,生成markdown接口文档

    文档管理,离线文档MD,下载保存。Word需要安装Writage插件,即可转换为doc、pdf文档。

生成接口文档的逻辑,是用数据io.swagger.models.Swagger渲染freemarker等模板页面,想要支持其他更多的模板,可以到apidoc项目加入扩展功能。

apidoc 生成swagger接口文档