Já utilizou a ferramenta Swagger para documentar a API?

Sim, utilizei Swagger para documentar APIs em projetos Node.js. Swagger permite descrever a estrutura da API usando a especificação OpenAPI, o que facilita a compreensão e teste das interfaces. Normalmente uso o pacote swagger-jsdoc para gerar documentação a partir de comentários no código e swagger-ui-express para exibir a documentação interativa.

Exemplo de integração do Swagger numa aplicação Express:

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: 'API de Exemplo',
      version: '1.0.0',
    },
  },
  apis: ['./routes/*.js'], // caminho para os ficheiros com comentários
};

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

app.listen(3000, () => console.log('Servidor iniciado'));

Isto permite criar e manter automaticamente a documentação atualizada da API.