📒 This is a ReDoc powered frontend for your NestJS API spec.

• Customizable theme
• It's almost a drop in replacement for you current swagger UI, you only need to import this package and modify any settings you may want to change (e.g: Page title, ReDoc options)

Using npm: npm i nestjs-redoc

Using yarn: yarn add nestjs-redoc

You need to install the Swagger Module first if you want to get definitions updated with your project.

In future versions you will be able to pass a URL parameter as document, but for the moment you need this document object from the swagger module

const options = new DocumentBuilder()
  .setTitle('Look, i have a title')
  .setDescription('A very nice description')
  .setBasePath('/api/v1')
  .build();
const document = SwaggerModule.createDocument(app, options);

Then add the following example code.

Note: All properties are optional, if you don't specify a title we will fallback to the one you used in your DocumentBuilder instance.

const redocOptions: RedocOptions = {
  title: 'Hello Nest',
  logo: {
    url: 'https://redocly.github.io/redoc/petstore-logo.png',
    backgroundColor: '#F0F0F0',
    altText: 'PetStore logo'
  },
  sortPropsAlphabetically: true,
  hideDownloadButton: false,
  hideHostname: false,
  auth: {
    enabled: true,
    user: 'admin',
    password: '123'
  },
  tagGroups: [
    {
      name: 'Core resources',
      tags: ['cats'],
    },
  ],
};
// Instead of using SwaggerModule.setup() you call this module
await RedocModule.setup('/docs', app, document, redocOptions);

Note: If you want to change your ReDoc theme settings, take a look at the official ReDoc documentation: https://github.com/Redocly/redoc/blob/master/src/theme.ts

Apply the properties defined in ResolvedThemeInterface to the key called "theme" in the redoc options

• Special thanks to Jay McDoniel (jmcdo29) who helped with code refactoring and unit tests! 👏
• @joemaidman

Bellow are a list of changes, some might go undocumented

• 1.0.0 - First release
• 1.1.0 - Minor changes, nothing too important
• 1.2.0 - Added unit tests, refactored code
• 1.2.1 - Updated to work with the latest version of nest swagger module
• 1.2.2 - Fixed issue with URL on windows
• 1.3.0 - Added favicon option (by @joemaidman)
• 2.0.0 - Added authentication option, fixed issues with CSP and nestjs version compatibility issues
• 2.1.0 - Added x-tagGroups extension property
• 2.1.1 - Fixed CSP issue on Safari browser
• 2.2.0 - Added version property, this way you can pin redoc to a specific version
• 2.2.2 - Updated to support Nest 8

• Add Fastify support
• Add the option to use a spec URL instead of document
• Fix tests