Files

Vladimír Gorej 11957fb868 chore: regenerate package-lock.json (#8411 )

package-lock.json was regenerated using Node@16.13.2
and npm@8.1.2. Along with that, these Node.js and npm
versions were set to .nvmrc file.

Given that the dependency tree now changed,
webpack config resolve aliases needed to be
amended to reflect the current dependency tree.

2023-02-23 16:34:17 +01:00

1.5 KiB

Raw Blame History

Setting up a dev environment

Swagger UI includes a development server that provides hot module reloading and unminified stack traces, for easier development.

Prerequisites

git, any version
Node.js >=16.13.2 and npm >=8.1.2 are the minimum required versions that this repo runs on, but we recommend using the latest version of Node.js@16

Steps

git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
npm run dev
Wait a bit
Open http://localhost:3200/

Using your own local api definition with local dev build

You can specify a local file in dev-helpers/swagger-initializer.js by changing the url parameter. This local file MUST be located in the dev-helpers directory or a subdirectory. As a convenience and best practice, we recommend that you create a subdirectory, dev-helpers/examples, which is already specified in .gitignore.

replace

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

with

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

Files in dev-helpers should NOT be committed to git. The exception is if you are fixing something in index.html, oauth2-redirect.html, swagger-initializer.js, or introducing a new support file.

Bonus points

Swagger UI includes an ESLint rule definition. If you use a graphical editor, consider installing an ESLint plugin, which will point out syntax and style errors for you as you code.
- The linter runs as part of the PR test sequence, so don’t think you can get away with not paying attention to it!

1.5 KiB Raw Blame History Unescape Escape