Installation

1. Install redocusaurus:

npm i --save redocusaurus

1. Add it as a preset to your docusaurus config and pass options:

   • Pass it a OpenAPI spec URL

     // docusaurus.config.js
     
     module.exports = {
       // ...
       presets: [
         [
           'redocusaurus',
           {
             // Plugin Options
             specs: [
               {
                 specUrl: 'https://redocly.github.io/redoc/openapi.yaml',
               },
             ],
             // Theme Options
             theme: {},
           },
         ],
       ],
       // ...
     };

   • Pass it a OpenAPI spec local path

     // docusaurus.config.js
     
     module.exports = {
       // ...
       presets: [
         [
           'redocusaurus',
           {
             // Plugin Options
             specs: [
               {
                 spec: 'openapi.yaml',
               },
             ],
             // Theme Options
             theme: {},
           },
         ],
       ],
       // ...
     };

The API Doc will be available by default at /api/ path. If you wish to override this path, you may set the routePath option. To skip adding a route altogether, set the addRoute option to false. You will still be able to reference schema elements manually using Schema Imports.

// docusaurus.config.js

module.exports = {
  // ...
  presets: [
    [
      'redocusaurus',
      {
        specs: [
          {
            id: 'default-route',
            // routePath: '/api/',
            // addRoute: true,
          },
          {
            id: 'route-overridden',
            routePath: '/different-path/',
            // addRoute: true,
          },
          {
            id: 'no-route',
            addRoute: false,
          },
        ],
      },
    ],
  ],
  // ...
};

Options

specs

An array of plugin options, see plugin options for individual option details.

theme

Pass options to customize the theme, see theme options for individual option details.