swagger-ui-dist

API Documentation

Serve the Swagger UI as a static site in an Express application, providing a visual documentation for your API.

const swaggerUi = require('swagger-ui-dist');
const express = require('express');
const app = express();

app.use('/api-docs', express.static(swaggerUi.getAbsoluteFSPath()));

app.listen(3000, () => {
  console.log('Swagger UI hosted at http://localhost:3000/api-docs');
});

Customization

Customize the Swagger UI by replacing the default URL with your API's URL before serving the HTML file.

const pathToSwaggerUi = require('swagger-ui-dist').absolutePath();
const http = require('http');
const fs = require('fs');

http.createServer((req, res) => {
  if (req.url === '/api-docs') {
    fs.readFile(`${pathToSwaggerUi}/index.html`, 'utf-8', (err, data) => {
      if (err) {
        res.writeHead(404);
        res.end('Not found');
      } else {
        // Customize HTML before sending it
        const result = data.replace('https://petstore.swagger.io/v2/swagger.json', 'url_to_your_api.json');
        res.writeHead(200, {'Content-Type': 'text/html'});
        res.end(result);
      }
    });
  }
}).listen(8080);