标题背景
我们在项目开发完成,接口写好后,需要将接口文档给到前端同学,或者合作方的工程师。但 swagger
对接口阅读并不友好,大部分情况下还得把服务启动好才能访问。这篇文章给各位开发人员介绍如何使用 docway 将 swagger 导出 PDF 或者 markdown 。
第一步:准备 swagger json
- 打开 swagger ui 的页面
- 点击 swagger json 的链接(可能没有显示该链接)
- 如果你的 swagger 页面没有显示该链接,F12打开开发者工具,重新刷新后,复制 api-docs 的响应内容。
4. 在弹出的tab页中或者 api-docs 的内容,复制下来或者保存到本地文件中
标题第二步:将 swagger json 导入 docway
-
在控制台中,新增项目,选择 导入