Configuración básica de Swagger en Express

Paso 1: Configuración inicial

Crea un nuevo proyecto de Node.js y asegúrate de tener Node.js y npm instalados en tu sistema.
Inicializa un nuevo proyecto npm en tu directorio de trabajo utilizando el siguiente comando:
```
npm init -y
```
Instala las dependencias necesarias ejecutando el siguiente comando:
```
npm install express swagger-jsdoc swagger-ui-express
```

Paso 2: Configuración de Express

Crea un archivo app.js o index.js y añade el siguiente código para configurar Express:

const express = require('express');
const app = express();

// Rutas de tu aplicación Express

// Puerto de escucha
const PORT = 3000;
app.listen(PORT, () => {
  console.log(`Servidor Express escuchando en el puerto ${PORT}`);
});

Paso 3: Configuración de Swagger

Crea un archivo swagger.js en la raíz de tu proyecto y añade el siguiente código:

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

// Opciones de configuración para Swagger
const swaggerOptions = {
  definition: {
    openapi: '3.0.0',
    info: {
      title: 'API de Ejemplo',
      version: '1.0.0',
      description: 'Una API de ejemplo utilizando Swagger y Express',
    },
  },
  apis: ['app.js'], // Especifica aquí la ruta a tu archivo principal de rutas de Express
};

const swaggerDocs = swaggerJsDoc(swaggerOptions);

// Agrega Swagger UI a tu aplicación Express
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocs));

Paso 4: Documenta tus rutas

En tu archivo principal de rutas de Express (app.js), utiliza comentarios JSDoc para documentar cada ruta. Aquí tienes un ejemplo:

/**
 * @swagger
 * /ruta:
 *   get:
 *     summary: Obtiene todos los elementos.
 *     responses:
 *       200:
 *         description: Operación exitosa.
 */
app.get('/ruta', (req, res) => {
  // Lógica de la ruta
  res.send('Obteniendo todos los elementos');
});

Paso 5: Ejecuta la aplicación

Ejecuta la aplicación Express utilizando el siguiente comando:
```
node app.js
```

Paso 6: Accede a la documentación Swagger

Abre tu navegador web y visita la siguiente URL:
```
http://localhost:3000/api-docs
```

¡Eso es todo! Ahora deberías ver la documentación Swagger generada para tu API en la ruta /api-docs.

Recuerda que esta es solo una guía básica para configurar Swagger en Express. Puedes personalizar y mejorar la configuración según tus necesidades. Consulta la documentación oficial de Swagger, swagger-jsdoc y swagger-ui-express para obtener más detalles sobre cómo utilizar y personalizar Swagger en Express.

Implementar Swagger en Express

Configuración básica de Swagger en Express