Peter Mooney 296f73aa00 | 4 years ago | |
---|---|---|
.. | ||
dist | 5 years ago | |
release | 5 years ago | |
README.md | 4 years ago | |
index.js | 4 years ago |
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:
react
and react-dom
as peerDependencies instead of production dependenciesVersions of this module mirror the version of Swagger UI included in the distribution.
Install swagger-ui-react
:
$ npm i --save swagger-ui-react
Use it in your React application:
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" />
These props map to Swagger UI configuration options of the same name.
spec
: PropTypes.objectAn 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.stringRemote 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.
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
orreq => 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
orres => 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.numberThe 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.
plugins
: PropTypes.arrayOf(PropTypes.object),An array of objects that augment and modify Swagger UI’s functionality. See Swagger UI’s Plugin API 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.
We intend to address these limitations based on user demand, so please open an issue or pull request if you have a specific request.
package.json
in the same folder as this README is not the manifest that should be used for releases - another manifest is generated at build-time and can be found in ./dist/
.For anything else, check the Swagger-UI repository.