设置开发环境

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 定义和本地开发构建

您可以通过更改 url 参数在 dev-helpers/dev-helper-initializer.js 中指定一个本地文件。此本地文件必须位于 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 测试序列的一部分运行，所以不要认为你可以不注意它！