Have you used the Swagger tool for API documentation?

Yes, I have used Swagger for documenting APIs in Node.js projects. Swagger allows describing the API structure using the OpenAPI specification, which simplifies understanding and testing interfaces. I usually use the swagger-jsdoc package to generate documentation from code comments and swagger-ui-express to display interactive documentation.

Example of integrating Swagger into an Express application:

const express = require('express');
const swaggerJsdoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');

const app = express();

const options = {
  definition: {
    openapi: '3.0.0',
    info: {
      title: 'Example API',
      version: '1.0.0',
    },
  },
  apis: ['./routes/*.js'], // path to files with comments
};

const specs = swaggerJsdoc(options);
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(specs));

app.listen(3000, () => console.log('Server started'));

This allows automatically creating and maintaining up-to-date API documentation.