kyy/swagger-ui
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Properly added name config

Browse Source 
Now access it through getConfigs
Documented it in README
This commit is contained in:
Jesse Mandel
2017-06-26 22:49:57 -07:00
parent b942d08923
commit 41e4d98a4c
3 changed files with 6 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

3
README.md
View File

@@ -130,6 +130,7 @@ Parameter Name | Description
--- | ---
url | The url pointing to API definition (normally `swagger.json` or `swagger.yaml`). Will be ignored if `urls` or `spec` is used.
urls | An array of API definition objects (`{url: "<url>", name: "<name>"}`) used by Topbar plugin. When used and Topbar plugin is enabled, the `url` parameter will not be parsed.
name | When using `urls`, you can use this parameter select an initial spec instead of defaulting to the first one. Useful as a query parameter to link to a specific spec.
spec | A JSON object describing the OpenAPI Specification. When used, the `url` parameter will not be parsed. This is useful for testing manually-generated specifications without hosting them.
validatorUrl | By default, Swagger-UI attempts to validate specs against swagger.io's online validator. You can use this parameter to set a different validator URL, for example for locally deployed validators ([Validator Badge](https://github.com/swagger-api/validator-badge)). Setting it to `null` will disable validation.
dom_id | The id of a dom element inside which SwaggerUi will put the user interface for swagger.
@@ -144,7 +145,7 @@ displayOperationId | Controls the display of operationId in operations list. The
### Plugins
#### Topbar plugin
Topbar plugin enables top bar with input for spec path and explore button or a dropdown if `urls` is used. When using the dropdown, a query parameter `name` can be passed to select that API. By default the plugin is enabled, and to disable it you need to remove Topbar plugin from presets in `src/standalone/index.js`:
Topbar plugin enables top bar with input for spec path and explore button or a dropdown if `urls` is used. By default the plugin is enabled, and to disable it you need to remove Topbar plugin from presets in `src/standalone/index.js`:
```
let preset = [

2
src/core/index.js
View File

@@ -6,7 +6,7 @@ import ApisPreset from "core/presets/apis"
import * as AllPlugins from "core/plugins/all"
import { parseSeach, filterConfigs } from "core/utils"
const CONFIGS = [ "url", "urls", "spec", "validatorUrl", "onComplete", "onFailure", "authorizations", "docExpansion",
const CONFIGS = [ "url", "urls", "name", "spec", "validatorUrl", "onComplete", "onFailure", "authorizations", "docExpansion",
"apisSorter", "operationsSorter", "supportedSubmitMethods", "dom_id", "defaultModelRendering", "oauth2RedirectUrl",
"showRequestHeaders", "custom", "modelPropertyMacro", "parameterMacro", "displayOperationId" ]

6
src/plugins/topbar/topbar.jsx
View File

@@ -2,7 +2,6 @@ import React, { PropTypes } from "react"
//import "./topbar.less"
import Logo from "./logo_small.png"
import { parseSeach } from "core/utils"
export default class Topbar extends React.Component {
@@ -37,10 +36,11 @@ export default class Topbar extends React.Component {
}
componentWillMount() {
const urls = this.props.getConfigs().urls || []
const configs = this.props.getConfigs()
const urls = configs.urls || []
if(urls && urls.length) {
let selectedName = parseSeach().name
let selectedName = configs.name
if(selectedName)
{
urls.forEach((spec, i) => {