Swagger 是一個強大的平台，專門用於開發、構建和記錄 RESTful Web 接口。通過其提供的交互式用户界面，開發人員能夠輕鬆且迅速地創建和測試 API。Swagger 還允許用户以多種格式，包括 JSON 和 Markdown，導出 API 文檔。選擇 JSON 格式可以便於與其他應用或工具集成，而 Markdown 格式則更適合創建直觀、易於閲讀的文檔。

下面，我們將以 Swagger Petstore 項目為例，來探討如何將 Swagger 文檔轉換為其他文件格式。我們將分享在開發過程中常用的一種方法。

從 Swagger Petstore 導出 JSON 文件

首先，訪問 Swagger Petstore，在頁面中找到 swagger.json 文件，右鍵點擊並選擇“保存鏈接為…”將文件下載到本地。

在 Apifox 中導入 Swagger 文件

接着，打開 Apifox 網站，並創建一個新項目。在項目設置中選擇“導入數據”選項，然後選擇“OpenAPI/Swagger”並通過“文件導入”上傳之前保存的 JSON 文件。

在導入過程中，Apifox 提供了一個預覽界面，允許您全選或部分選擇接口進行導入。一旦完成導入，就可以設置環境並測試接口了。

將文檔導出為 Markdown

在 Apifox 項目設置中，找到“導出數據”選項並選擇“Markdown 格式”。這將把整個項目文檔轉換為一個 Markdown 文件，包括 API 目錄和所有必要的請求數據，方便查看和使用。

Markdown 轉換為 PDF 或 Word

Markdown 文件具備轉換為其他文件格式的靈活性。用户可使用多種工具或插件來實現這一轉換。例如，在 Visual Studio Code (Vscode) 中，通過安裝 Markdown PDF 插件，用户可以輕鬆將 Markdown 文件另存為 PDF 或 Word 文檔。

下載並安裝插件後，打開你的 Markdown 文件，點擊右上角的轉換按鈕，然後在頁面空白區域右鍵選擇你想要的文件格式進行導出。

結論

通過以上步驟，使用 Swagger 和 Apifox，您可以無需複雜配置或編程即可完整地管理 API 文檔的創建、測試和轉換流程。這整個過程簡潔且高效，節省了大量的時間和資源。