redoc-try
v1.4.10
Published
[๐ online preview](https://wll8.github.io/redoc-try/index.html)
Downloads
161
Readme
redoc try
- ๐ View video
- ๐ online ./test/openapi.3.yaml
- ๐ online ./test/swagger.2.json
- ๐ online https://httpbin.org/spec.json
Add Try it out function like swagger on redoc, Compatible with yaml/json/3.0/2.0.
how to use?
<body>
<div id="redoc-container"></div>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/bundles/redoc.standalone.min.js"> </script>
<script src="https://cdn.jsdelivr.net/npm/[email protected]/dist/try.js"></script>
<script>
// initTry(`https://petstore.swagger.io/v2/swagger.json`)
initTry({
openApi: `https://petstore.swagger.io/v2/swagger.json`,
redocOptions: {scrollYOffset: 50},
})
</script>
</body>Note: No need to use <redoc /> anymore.
Options
When the parameter type is a string, the value is openApi.
When the parameter type is an object, you can configure the following:
initTry({
openApi: `https://petstore.swagger.io/v2/swagger.json`, // openApi address
// cndPrefix: `https://cdn.jsdelivr.net/npm/`, // Reference prefix of related dependencies
// redocVersion: `2.0.0-rc.48`, // Used to handle compatibility issues, if not specified, read from the URL
// onlySwagger: true,
// tryText: `try`, // Try button text
// trySwaggerInApi: true, // Whether to display swagger debugging window under api?
// redocOptions: {enableConsole: true}, // Or the format is an array: `[specOrSpecUrl?, options?, element?, callback?]`
// swaggerOptions: {dom_id: `#swagger-ui`},
// pure: false, // Concise mode, hide some existing elements of redoc
})Why do you need it?
According to the description of #53, the try function is no longer developed, maybe it has become a paid function.
If you need to simply have this feature, you don't need to redevelop it, because it will consume a lot of time and lack community maintenance.
We chose to transplant Swagger's Try it out function, which is complete, has community maintenance, and is familiar.
Related tools
- redoc-try-it-out Close to the visual style of redoc, more options can be configured.
License
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2004 Sam Hocevar <[email protected]>
Everyone is permitted to copy and distribute verbatim or modified
copies of this license document, and changing it is allowed as long
as the name is changed.
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
TERMS AND CONDITIONS FOR COPYING, DISTRIBUTION AND MODIFICATION
0. You just DO WHAT THE FUCK YOU WANT TO.