◉◡◉ 您好,欢迎到访伊成个人站!

如何将 swagger接口导出成PDF、markdown

写在前面

swagger提供了UI页面,假如需要给合作伙伴对应的开发者,一般都需要提供一份接口PDF文件或是对应的markdown文件,这个时候就需要将对应swagger接口进行导出操作了。

具体步骤

第一步:准备swagger json文件

1.打开 swagger ui 的页面

2.点击 swagger json 的链接,具体如下图:
“伊成博客”

tips:如果你没有看到这个链接,使用F12打开开发者工具重新刷新后,复制 api-docs 的响应内容。

一定要保存成 json 文件。

第二步: 把swagger json文件导入 docway

1.登录 http://docway.net (如果第一次使用,需要注册)

2.在控制台中,新增项目,选择 导入
“伊成博客”

3.选择 swagger 导入,并根据自己的 swagger json 选择是“上传文件方式”还是“粘贴json方式”
“伊成博客”

4.导入成功后,就可以看到对应的信息了
“伊成博客”

第三步:导出PDF或markdown

1.在项目的“更多设置”中,找到“项目导出”功能。可以选择 PDF或Markdown 导出即可
“伊成博客”

小结

总体来说docway导出的PDF接口文件还是不错的,如果选择 PDF(浏览器版)对应的接口文件则是带有颜色的。如果选择的是 仅仅 PDF生成的接口文件页脚是带有docway的网站链接的。

docway除了 PDF、markdown 导出, 还支持接口设计、接口分享、接口mock、接口历史记录、接口版本管理、团队管理等功能。


The end.

支付宝打赏 微信打赏