背景
我们在项目开发完成,接口写好后,需要将接口文档给到前端同学,或者合作方的工程师。但 swagger 对接口阅读并不友好,大部分情况下还得把服务启动好才能访问。这篇文章给各位开发人员介绍如何使用 docway 将 swagger 导出 PDF 或者 markdown 。
第一步:准备 swagger json
1. 打开 swagger ui 的页面
2. 点击 swagger json 的链接(可能没有显示该链接)
3. 如果你的 swagger 页面没有显示该链接,F12打开开发者工具,重新刷新后,复制 api-docs 的响应内容。
4. 在弹出的tab页中或者 api-docs 的内容,复制下来或者保存到本地文件中
第二步:将 swagger json 导入 docway
1. 登录 http://docway.net
2. 在控制台中,新增项目,选择 导入
3. 选择 swagger 导入,并根据自己的 swagger json 选择是“上传文件方式”还是“粘贴json方式”
4. 导入后,便可以看到项目信息了
第三步:导出 PDF markdown
1. 在项目的“更多设置”中,找到“项目导出”功能。可以选择 PDF Markdown 导出。
docway 是一款在线接口文档管理工具,除了 PDF markdown 导出, 还支持接口设计、接口分享、接口mock、接口历史记录、接口版本管理、团队管理等功能。
网友评论