Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/wll8/redoc-try
Add `Try it out` function like swagger on redoc.
https://github.com/wll8/redoc-try
redoc swagger try-it-out
Last synced: about 5 hours ago
JSON representation
Add `Try it out` function like swagger on redoc.
- Host: GitHub
- URL: https://github.com/wll8/redoc-try
- Owner: wll8
- Created: 2020-05-18T06:20:51.000Z (over 4 years ago)
- Default Branch: main
- Last Pushed: 2024-10-11T09:32:19.000Z (about 1 month ago)
- Last Synced: 2024-10-12T04:44:48.479Z (about 1 month ago)
- Topics: redoc, swagger, try-it-out
- Language: JavaScript
- Homepage: https://wll8.github.io/redoc-try
- Size: 803 KB
- Stars: 113
- Watchers: 5
- Forks: 33
- Open Issues: 3
-
Metadata Files:
- Readme: readme.md
Awesome Lists containing this project
README
## redoc try
- [👉 View video](https://user-images.githubusercontent.com/28223260/200719793-cd027f71-e863-4d6b-a519-7ed6105e2461.mp4)
- [👉 online ./test/openapi.3.yaml](https://wll8.github.io/redoc-try/index.html?openApi=./test/openapi.3.yaml)
- [👉 online ./test/swagger.2.json](https://wll8.github.io/redoc-try/index.html?openApi=./test/swagger.2.json)
- [👉 online https://httpbin.org/spec.json](https://wll8.github.io/redoc-try/index.html?openApi=https://httpbin.org/spec.json)
Add `Try it out` function like [swagger](https://petstore.swagger.io/) on [redoc](https://github.com/Redocly/redoc), Compatible with `yaml/json/3.0/2.0`.
## how to use?
``` html
// initTry(`https://petstore.swagger.io/v2/swagger.json`)
initTry({
openApi: `https://petstore.swagger.io/v2/swagger.json`,
redocOptions: {scrollYOffset: 50},
})
```
Note: No need to use `` 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:
``` js
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](https://github.com/Redocly/redoc/issues/53#issuecomment-576377856), 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](https://github.com/amorimjj/redoc-try-it-out) Close to the visual style of redoc, more options can be configured.
## License
[WTFPL](https://en.wikipedia.org/wiki/WTFPL):
``` txt
DO WHAT THE FUCK YOU WANT TO PUBLIC LICENSE
Version 2, December 2004
Copyright (C) 2004 Sam Hocevar
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.
```