docusaurus-plugin-redoc v2.0.2
Docusaurus Plugin Redoc
This plugin parses your OpenAPI spec files and creates pages using the ApiDoc
component from your theme. Use with docusaurus-theme-redoc
.
Read More Here: https://github.com/rohit-gohri/redocusaurus
Options
Either of spec
or specUrl
is required.
spec
A path to a OpenAPI yaml or json file. Will be parsed and forwarded to Redoc component. This has higher priority over specUrl.
specUrl
A url pointing to an OpenAPI spec.
layout
An object to pass as layout props. Useful to set title/description of the page. See all properties available here.
routePath (default: /api/
)
Route URL at which docs would be available
apiDocComponent (default: @theme/ApiDoc
)
If you want to use a custom component to render the spec instead of the one with docusaurus-theme-redoc
then overwrite this with a path to the component.
It will be forwarded a single prop, see ApiDoc for example.
1 month ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
2 months ago
6 months ago
6 months ago
6 months ago
6 months ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
1 year ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
2 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago
3 years ago