swagger-ui-4.12.0.tar.gz

# `swagger-ui-react` [](http://badge.fury.io/js/swagger-ui-react) `swagger-ui-react` is a flavor of Swagger UI suitable for use in React applications. It has a few differences from the main version of Swagger UI: * Declares `react` and `react-dom` as peerDependencies instead of production dependencies * Exports a component instead of a constructor function Versions of this module mirror the version of Swagger UI included in the distribution. ## Quick start Install `swagger-ui-react`: ``` $ npm i --save swagger-ui-react ``` Use it in your React application: ```js import SwaggerUI from "swagger-ui-react" import "swagger-ui-react/swagger-ui.css" export default App = () => <SwaggerUI url="https://petstore.swagger.io/v2/swagger.json" /> ``` ## Props These props map to [Swagger UI configuration options](https://github.com/swagger-api/swagger-ui/blob/master/docs/usage/configuration.md) of the same name. #### `spec`: PropTypes.object An OpenAPI document respresented as a JavaScript object, JSON string, or YAML string for Swagger UI to display. ⚠️ Don't use this in conjunction with `url` - unpredictable behavior may occur. #### `url`: PropTypes.string Remote URL to an OpenAPI document that Swagger UI will fetch, parse, and display. ⚠️ Don't use this in conjunction with `spec` - unpredictable behavior may occur. #### `layout`: PropTypes.string The name of a component available via the plugin system to use as the top-level layout for Swagger UI. The default value is `BaseLayout`. ⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change. #### `onComplete`: PropTypes.func > `(system) => void` A callback function that is triggered when Swagger-UI finishes rendering an OpenAPI document. Swagger UI's `system` object is passed as an argument. #### `requestInterceptor`: PropTypes.func > `req => req` or `req => Promise<req>`. A function that accepts a request object, and returns either a request object or a Promise that resolves to a request object. #### `responseInterceptor`: PropTypes.func > `res => res` or `res => Promise<res>`. A function that accepts a response object, and returns either a response object or a Promise that resolves to a response object. #### `docExpansion`: PropTypes.oneOf(['list', 'full', 'none']) Controls the default expansion setting for the operations and tags. It can be 'list' (expands only the tags), 'full' (expands the tags and operations) or 'none' (expands nothing). The default value is 'list'. ⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change. #### `defaultModelExpandDepth`: PropTypes.number The default expansion depth for models (set to -1 completely hide the models). ⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change. #### `defaultModelRendering`: PropTypes.oneOf(["example", "model"]) Controls how the model is shown when the API is first rendered. (The user can always switch the rendering for a given model by clicking the 'Model' and 'Example Value' links.) The default value is 'example'. ⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change. #### `displayOperationId`: PropTypes.bool Controls the display of operationId in operations list. The default is false. ⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change. #### `plugins`: PropTypes.arrayOf(PropTypes.object), An array of objects that augment and modify Swagger UI's functionality. See Swagger UI's [Plugin API](https://github.com/swagger-api/swagger-ui/blob/master/docs/customization/plugin-api.md) for more details. ⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change. #### `supportedSubmitMethods`: PropTypes.arrayOf(PropTypes.oneOf(['get', 'put', 'post', 'delete', 'options', 'head', 'patch', 'trace'])) HTTP methods that have the Try it out feature enabled. An empty array disables Try it out for all operations. This does not filter the operations from the display. ⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change. #### `showExtensions`: PropTypes.bool Controls the display of vendor extension (`x-`) fields and values for Operations, Parameters, Responses, and Schema. ⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change. #### `showMutatedRequest`: PropTypes.bool If set to `true`, uses the mutated request returned from a requestInterceptor to produce the curl command in the UI, otherwise the request before the requestInterceptor was applied is used. ⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change. #### `presets`: PropTypes.arrayOf(PropTypes.func), An array of functions that augment and modify Swagger UI's functionality. See Swagger UI's [Plugin API](https://github.com/swagger-api/swagger-ui/blob/master/docs/customization/plugin-api.md) for more details. ⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change. #### `tryItOutEnabled`: PropTypes.bool Controls whether the "Try it out" section should start enabled. The default is false. ⚠️ This prop is currently only applied once, on mount. Changes to this prop's value will not be propagated to the underlying Swagger UI instance. A future version of this module will remove this limitation, and the change will not be considered a breaking change. #### `displayRequestDuration`: PropTypes.bool Controls the display of the request duration (in milliseconds) for "Try it out" requests. The default is false. #### `filter`: PropTypes.oneOfType([PropTypes.string, PropTypes.bool]) If set, enables filtering. The top bar will show an edit box that you can use to filter the tagged operations that are shown. Can be Boolean to enable or disable, or a string, in which case filtering will be enabled using that string as the filter expression. Filtering is case sensitive matching the filter expression anywhere inside the tag. See Swagger UI's [Plug Points](https://github.com/swagger-api/swagger-ui/blob/master/docs/cust