背景

我們?cè)陧?xiàng)目開(kāi)發(fā)完成，接口寫(xiě)好后，需要將接口文檔給到前端同學(xué)，或者合作方的工程師。但 swagger 對(duì)接口閱讀并不友好，大部分情況下還得把服務(wù)啟動(dòng)好才能訪(fǎng)問(wèn)。這篇文章給各位開(kāi)發(fā)人員介紹如何使用 docway 將 swagger 導(dǎo)出 PDF 或者 markdown 。

第一步：準(zhǔn)備 swagger json

1. 打開(kāi) swagger ui 的頁(yè)面

2. 點(diǎn)擊 swagger json 的鏈接（可能沒(méi)有顯示該鏈接）

3. 如果你的 swagger 頁(yè)面沒(méi)有顯示該鏈接，F(xiàn)12打開(kāi)開(kāi)發(fā)者工具，重新刷新后，復(fù)制 api-docs 的響應(yīng)內(nèi)容。

4. 在彈出的tab頁(yè)中或者 api-docs 的內(nèi)容，復(fù)制下來(lái)或者保存到本地文件中

第二步：將 swagger json 導(dǎo)入 docway

1. 登錄 http://docway.net

2. 在控制臺(tái)中，新增項(xiàng)目，選擇 導(dǎo)入

3. 選擇 swagger 導(dǎo)入，并根據(jù)自己的 swagger json 選擇是“上傳文件方式”還是“粘貼json方式”

4. 導(dǎo)入后，便可以看到項(xiàng)目信息了

第三步：導(dǎo)出 PDF markdown

1. 在項(xiàng)目的“更多設(shè)置”中，找到“項(xiàng)目導(dǎo)出”功能?？梢赃x擇 PDF Markdown 導(dǎo)出。

docway 是一款在線(xiàn)接口文檔管理工具，除了 PDF markdown 導(dǎo)出， 還支持接口設(shè)計(jì)、接口分享、接口mock、接口歷史記錄、接口版本管理、團(tuán)隊(duì)管理等功能。