Documentation: مستندسازی API 📚

API Documentation برای کمک به developers استفاده از API ضروریه!

استفاده از Swagger:

// نصب
// npm install swagger-ui-express swagger-jsdoc

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

const options = {
    definition: {
        openapi: '3.0.0',
        info: {
            title: 'My API',
            version: '1.0.0',
            description: 'API Documentation'
        },
        servers: [
            { url: 'http://localhost:3000' }
        ]
    },
    apis: ['./routes/*.js']
};

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

Documenting Routes:

/**
 * @swagger
 * /api/users:
 *   get:
 *     summary: Get all users
 *     responses:
 *       200:
 *         description: List of users
 */
app.get('/api/users', (req, res) => {
    res.json({ users: [] });
});