@paloaltonetworks/docusaurus-plugin-openapi
v18.0.0-beta.2
Published
OpenAPI plugin for Docusaurus.
Downloads
28
Readme
OpenAPI plugin for generating API reference docs in Docusaurus v2.
Multiple OpenAPI Definitions
To have more than one OpenAPI pages, add additional OpenAPI plugin instances:
/* docusaurus.config.js */
{
presets: [
[
'docusaurus-preset-openapi',
{
api: {
// id: 'cars', // omitted => default instance
path: 'cars/openapi.json',
routeBasePath: 'cars',
// ... other options
},
},
],
],
plugins: [
[
'docusaurus-plugin-openapi',
{
id: 'trains',
path: 'trains/openapi.json',
routeBasePath: 'trains',
// ... other options
},
],
[
'docusaurus-plugin-openapi',
{
id: 'bikes',
path: 'bikes/openapi.json',
routeBasePath: 'bikes',
// ... other options
},
],
],
}
This will create routes for /cars
, /trains
and /bikes
.
Note: One instance of the plugin is included in the preset. All additional plugin instances will require an
id
.