aboutsummaryrefslogtreecommitdiff
path: root/core-rest/src/main/resources/swagger-ui-dist/README.md
diff options
context:
space:
mode:
authorJakob Odersky <jakob@driver.xyz>2018-10-05 11:43:02 -0700
committerJakob Odersky <jakob@odersky.com>2018-10-09 16:19:39 -0700
commitd858e1ca733407aeeb39d9d85edb26373443a9b9 (patch)
tree28cfd4075c785eea9c2c2588c742d127d483c754 /core-rest/src/main/resources/swagger-ui-dist/README.md
parent59007a478595cb0876a65cd603f36d4b870c5c3d (diff)
downloaddriver-core-d858e1ca733407aeeb39d9d85edb26373443a9b9.tar.gz
driver-core-d858e1ca733407aeeb39d9d85edb26373443a9b9.tar.bz2
driver-core-d858e1ca733407aeeb39d9d85edb26373443a9b9.zip
Move resources to corresponding subprojects
Diffstat (limited to 'core-rest/src/main/resources/swagger-ui-dist/README.md')
-rw-r--r--core-rest/src/main/resources/swagger-ui-dist/README.md22
1 files changed, 22 insertions, 0 deletions
diff --git a/core-rest/src/main/resources/swagger-ui-dist/README.md b/core-rest/src/main/resources/swagger-ui-dist/README.md
new file mode 100644
index 0000000..6628422
--- /dev/null
+++ b/core-rest/src/main/resources/swagger-ui-dist/README.md
@@ -0,0 +1,22 @@
+# Swagger UI Dist
+[![NPM version](https://badge.fury.io/js/swagger-ui-dist.svg)](http://badge.fury.io/js/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:
+```javascript
+ import { SwaggerUIBundle, SwaggerUIStandalonePreset } from "swagger-ui-dist"
+```
+
+To get an absolute path to this directory for static file serving, use the exported `getAbsoluteFSPath` method:
+
+```javascript
+const swaggerUiAssetPath = require("swagger-ui-dist").getAbsoluteFSPath()
+
+// then instantiate server that serves files from the swaggerUiAssetPath
+```
+
+For anything else, check the [Swagger-UI](https://github.com/swagger-api/swagger-ui) repository.