redoc

What is redoc?

Redoc is an open-source tool for generating interactive API documentation from OpenAPI (formerly Swagger) definitions. It provides a user-friendly interface for exploring and understanding API endpoints, parameters, and responses.

What are redoc's main functionalities?

Render API Documentation

This feature allows you to render API documentation from an OpenAPI specification file. The `init` method takes the path to the OpenAPI file, optional configuration options, and the HTML element where the documentation should be rendered.

const Redoc = require('redoc');
Redoc.init('path/to/your/openapi.yaml', {
  scrollYOffset: 50
}, document.getElementById('redoc-container'));

Customization Options

Redoc allows for extensive customization of the rendered documentation. You can change the theme, colors, fonts, and other styles to match your branding.

const Redoc = require('redoc');
Redoc.init('path/to/your/openapi.yaml', {
  theme: {
    colors: {
      primary: {
        main: '#dd5522'
      }
    }
  }
}, document.getElementById('redoc-container'));

Standalone HTML Generation

Redoc provides a CLI tool to generate a standalone HTML file from an OpenAPI specification. This can be useful for hosting static API documentation without needing a server.

const { exec } = require('child_process');
exec('npx redoc-cli bundle path/to/your/openapi.yaml', (error, stdout, stderr) => {
  if (error) {
    console.error(`Error: ${error.message}`);
    return;
  }
  if (stderr) {
    console.error(`Stderr: ${stderr}`);
    return;
  }
  console.log(`Stdout: ${stdout}`);
});

Other packages similar to redoc

swagger-ui

Swagger UI is another popular tool for generating interactive API documentation from OpenAPI specifications. It offers a more traditional interface compared to Redoc and is highly customizable. Swagger UI is often used in conjunction with other Swagger tools for a complete API development workflow.

api-docs

API Docs is a lightweight tool for generating API documentation from OpenAPI specifications. It focuses on simplicity and ease of use, making it a good choice for smaller projects or teams that need quick and straightforward documentation.

spectacle

Spectacle is a tool for generating API documentation from OpenAPI specifications with a focus on readability and user experience. It offers a clean and modern interface, similar to Redoc, but with different customization options and features.

README

ReDoc

Swagger-generated API Reference Documentation

Under development

Live demo

Running locally

• Clone repository git clone https://github.com/Rebilly/ReDoc.git
• Go to the project folder cd ReDoc
• Install node modules npm install
• (optional) Replace demo/swagger.json with your own schema
• Start the server npm start
• Open http://localhost:9000