跳到内容

设置开发环境

SwaggerUI 包含一个开发服务器，提供热模块重载和未压缩的堆栈跟踪，以便于开发。

先决条件

  • git，任何版本
  • Node.js >=22.11.0 和 npm >=10.9.0 是此仓库运行所需的最低版本，但我们始终建议使用最新版本的 Node.js。

步骤

  1. git clone https://github.com/swagger-api/swagger-ui.git
  2. cd swagger-ui
  3. npm install
  4. npx husky init（可选）
  5. npm run dev
  6. 请稍候
  7. 打开 http://localhost:3200/

在本地开发构建中使用您自己的本地 API 定义

您可以通过更改 url 参数在 dev-helpers/dev-helper-initializer.js 中指定本地文件。此本地文件必须位于 dev-helpers 目录或其子目录中。为方便和最佳实践，我们建议您创建一个子目录 dev-helpers/examples，该目录已在 .gitignore 中指定。

替换

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

为

1
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 测试序列的一部分运行，所以别以为你可以不注意它！
© . All rights reserved.