19fe8fed6e | ||
---|---|---|
.. | ||
LICENSE | ||
NOTICE | ||
README.md | ||
absolute-path.js | ||
favicon-16x16.png | ||
favicon-32x32.png | ||
index.css | ||
index.html | ||
index.js | ||
oauth2-redirect.html | ||
package.json | ||
swagger-initializer.js | ||
swagger-ui-bundle.js | ||
swagger-ui-bundle.js.map | ||
swagger-ui-es-bundle-core.js | ||
swagger-ui-es-bundle-core.js.map | ||
swagger-ui-es-bundle.js | ||
swagger-ui-es-bundle.js.map | ||
swagger-ui-standalone-preset.js | ||
swagger-ui-standalone-preset.js.map | ||
swagger-ui.css | ||
swagger-ui.css.map | ||
swagger-ui.js | ||
swagger-ui.js.map |
README.md
Swagger UI Dist
API
This module, swagger-ui-dist
, exposes Swagger-UI's entire dist folder as a dependency-free npm module.
Use swagger-ui
instead, if you'd like to have npm install dependencies for you.
SwaggerUIBundle
and SwaggerUIStandalonePreset
can be imported:
import { SwaggerUIBundle, SwaggerUIStandalonePreset } from "swagger-ui-dist"
To get an absolute path to this directory for static file serving, use the exported getAbsoluteFSPath
method:
const swaggerUiAssetPath = require("swagger-ui-dist").getAbsoluteFSPath()
// then instantiate server that serves files from the swaggerUiAssetPath
For anything else, check the Swagger-UI repository.