Properly added name config
Now access it through getConfigs Documented it in README
This commit is contained in:
@@ -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.
|
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.
|
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.
|
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.
|
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.
|
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
|
### Plugins
|
||||||
|
|
||||||
#### Topbar plugin
|
#### 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 = [
|
let preset = [
|
||||||
|
|||||||
@@ -6,7 +6,7 @@ import ApisPreset from "core/presets/apis"
|
|||||||
import * as AllPlugins from "core/plugins/all"
|
import * as AllPlugins from "core/plugins/all"
|
||||||
import { parseSeach, filterConfigs } from "core/utils"
|
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",
|
"apisSorter", "operationsSorter", "supportedSubmitMethods", "dom_id", "defaultModelRendering", "oauth2RedirectUrl",
|
||||||
"showRequestHeaders", "custom", "modelPropertyMacro", "parameterMacro", "displayOperationId" ]
|
"showRequestHeaders", "custom", "modelPropertyMacro", "parameterMacro", "displayOperationId" ]
|
||||||
|
|
||||||
|
|||||||
@@ -2,7 +2,6 @@ import React, { PropTypes } from "react"
|
|||||||
|
|
||||||
//import "./topbar.less"
|
//import "./topbar.less"
|
||||||
import Logo from "./logo_small.png"
|
import Logo from "./logo_small.png"
|
||||||
import { parseSeach } from "core/utils"
|
|
||||||
|
|
||||||
export default class Topbar extends React.Component {
|
export default class Topbar extends React.Component {
|
||||||
|
|
||||||
@@ -37,10 +36,11 @@ export default class Topbar extends React.Component {
|
|||||||
}
|
}
|
||||||
|
|
||||||
componentWillMount() {
|
componentWillMount() {
|
||||||
const urls = this.props.getConfigs().urls || []
|
const configs = this.props.getConfigs()
|
||||||
|
const urls = configs.urls || []
|
||||||
|
|
||||||
if(urls && urls.length) {
|
if(urls && urls.length) {
|
||||||
let selectedName = parseSeach().name
|
let selectedName = configs.name
|
||||||
if(selectedName)
|
if(selectedName)
|
||||||
{
|
{
|
||||||
urls.forEach((spec, i) => {
|
urls.forEach((spec, i) => {
|
||||||
|
|||||||
Reference in New Issue
Block a user