Reshuffle more documentation locations

This commit is contained in:
Kyle Shockey
2017-12-04 22:58:58 -08:00
parent c6bc13c3f5
commit 84f4ec805e
4 changed files with 21 additions and 61 deletions

View File

@@ -18,7 +18,7 @@ Swagger-UI includes a development server that provides hot module reloading and
5. Wait a bit
6. Open http://localhost:3200/
## Bonus round
## 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!

View File

@@ -1,5 +1,18 @@
# Configuration
#### How to configure
Swagger-UI accepts parameters in four ways.
From lowest to highest priority:
- `swagger-config.yaml` baked into project root directory
- configuration object passed as an argument to Swagger-UI (`SwaggerUI({ ... })`)
- configuration items fetched from a specified `configUrl`
- configuration items passed as key/value pairs in the URL query string
#### Parameters
Parameters with dots in their names are single strings used to organize subordinate parameters, and are not indicative of a nested structure.
Parameter Name | Description