設定開發環境

Swagger UI 包含一個開發伺服器，可提供熱模組重新載入和未壓縮的堆疊追蹤，以便於開發。

先決條件

• git，任何版本
• Node.js >=20.3.0 和 npm >=9.6.7 是此儲存庫執行的最低需求版本，但我們始終建議使用最新版本的 Node.js。

步驟

1. git clone https://github.com/swagger-api/swagger-ui.git
2. cd swagger-ui
3. npm install
4. npm run dev
5. 稍待片刻
6. 開啟 https://127.0.0.1:3200/

將您自己的本機 API 定義與本機開發版本搭配使用

您可以在 dev-helpers/dev-helper-initializer.js 中透過變更 url 參數來指定本機檔案。此本機檔案必須位於 dev-helpers 目錄或子目錄中。為了方便起見並遵循最佳做法，我們建議您建立一個子目錄 dev-helpers/examples，該目錄已在 .gitignore 中指定。

取代

url: "https://petstore.swagger.io/v2/swagger.json",

使用

url: "./examples/your-local-api-definition.yaml",

dev-helpers 中的檔案不應提交到 git。例外情況是如果您要修正 index.html、oauth2-redirect.html、dev-helper-initializer.js 中的錯誤，或是引入新的支援檔案。

加分項目

• Swagger UI 包含 ESLint 規則定義。如果您使用圖形編輯器，請考慮安裝 ESLint 外掛程式，它會在您編碼時指出語法和樣式錯誤。
  • linter 會作為 PR 測試序列的一部分執行，所以別以為可以不注意它！