Mercurial > gemma

annotate api/server/ui/README.md @ 221:696c19abe869

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Argh! If one is using its own storage for config like we do the config loaded by viper needs to be injected back into cobra [https://github.com/spf13/cobra/issues/367].
author Sascha L. Teichmann <sascha.teichmann@intevation.de>
date Tue, 24 Jul 2018 18:21:31 +0200
parents 9fcfccb18b16
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
169
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
1 # Swagger UI Dist
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
2 [![NPM version](https://badge.fury.io/js/swagger-ui-dist.svg)](http://badge.fury.io/js/swagger-ui-dist)
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
3
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
4 # API
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
5
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
6 This module, `swagger-ui-dist`, exposes Swagger-UI's entire dist folder as a dependency-free npm module.
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
7 Use `swagger-ui` instead, if you'd like to have npm install dependencies for you.
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
8
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
9 `SwaggerUIBundle` and `SwaggerUIStandalonePreset` can be imported:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
10 ```javascript
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
11 import { SwaggerUIBundle, SwaggerUIStandalonePreset } from "swagger-ui-dist"
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
12 ```
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
13
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
14 To get an absolute path to this directory for static file serving, use the exported `getAbsoluteFSPath` method:
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
15
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
16 ```javascript
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
17 const swaggerUiAssetPath = require("swagger-ui-dist").getAbsoluteFSPath()
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
18
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
19 // then instantiate server that serves files from the swaggerUiAssetPath
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
20 ```
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
21
9fcfccb18b16 feat: Added draft version of API specification for server
Thomas Junk <thomas.junk@intevation.de>
parents:
diff changeset
22 For anything else, check the [Swagger-UI](https://github.com/swagger-api/swagger-ui) repository.