Package Exports
- @sean-perkins/docusaurus-plugin-openapi
- @sean-perkins/docusaurus-plugin-openapi/lib/index.js
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@sean-perkins/docusaurus-plugin-openapi) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
Docusaurus OpenAPI
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.