Nestjs Redoc

Overview

The ReDoc powered frontend for your NestJS API spec brings a modern and easy-to-use interface for visualizing your API documentation. It's designed as a flexible and customizable replacement for your existing Swagger UI, streamlining the way you present your API specifications. Whether you're looking to enhance the user experience or simply want a fresh look, this library offers the tools needed for a polished presentation.

The installation is straightforward, requiring just a few steps with npm or yarn. Once set up, you can quickly adjust settings to match your project's needs. By leveraging this powerful tool, you can create a more engaging experience for developers consuming your API.

Features

• Customizable Theme: Tailor the appearance of your API documentation with a variety of theme options to suit your brand and preferences.
• Easy Installation: Quickly add the package to your project using npm or yarn for hassle-free implementation.
• Flexible Options: Modify properties such as the page title and favicon, allowing for a personalized touch to your documentation.
• HTML/Markdown Sanitization: The untrustedSpec option enhances security by sanitizing content to prevent XSS attacks.
• Warning Suppression: Control the visibility of warnings in your documentation with the suppressWarnings feature, keeping the user interface neat.
• Operation Definition Privacy: Use hideHostname to obscure protocol and hostname details in operation definitions, if desired.
• Response Expansion: Specify which response codes should be expanded by default, giving users a clearer understanding of API responses.