Versionamento

Fa parte della sezione API REST del percorso Node.js di Coddy. Lezione 15 di 18.

Modificare la struttura di una risposta compromette tutti i client che la utilizzano già. Una versione nel percorso consente ai client vecchi e nuovi di coesistere: /api/v1/orders oggi, /api/v2/orders quando cambia la struttura. I percorsi che vengono spostati rispondono con un reindirizzamento:

GET  /api/orders/5   →  308  Location: /api/v1/orders/5
POST /api/orders     →  308  Location: /api/v1/orders

301 e 302 consentono ai client di ripetere una POST come GET, eliminando il corpo. 308 indica «ripeti la stessa richiesta lì», metodo e corpo inclusi. All'interno di un middleware montato, req.url non contiene più il percorso di montaggio, mentre req.originalUrl lo conserva per intero:

// in app.use('/api/orders', ...) per GET /api/orders/5?full=1
req.url          // '/5?full=1'
req.originalUrl  // '/api/orders/5?full=1'

Sfida

Facile

Monta il router delle attività su /api/v1/tasks.
Ogni vecchio percorso /api/tasks risponde con 308 allo stesso percorso sotto /api/v1, inclusa la query.
Le nuove attività ricevono Location: /api/v1/tasks/<id>.

Invia GET /api/tasks/2, POST /api/tasks con { "title": "Order new chairs" }, poi GET /api/v1/tasks/2.

Provalo tu

import express from 'express';
import { sendError } from './errors.js';
import taskRoutes from './routes/tasks.js';

const BOARD_ORIGIN = 'https://board.example.com';

const app = express();
app.use(express.json());

// Consente alle pagine su BOARD_ORIGIN di chiamare questa API dal browser.
app.use((req, res, next) => {
    res.set('Access-Control-Allow-Origin', BOARD_ORIGIN);
    res.set('Access-Control-Allow-Credentials', 'true');
    if (req.method === 'OPTIONS') {
        res.set('Access-Control-Allow-Methods', 'GET, POST, PUT, PATCH, DELETE');
        res.set('Access-Control-Allow-Headers', 'Content-Type');
        return res.status(204).end();
    }
    next();
});

app.use(express.static('public'));

app.use('/api/tasks', taskRoutes);

// Gli errori delle route arrivano qui. Un corpo che non è JSON valido è un errore del
// client (400); qualsiasi altro errore è nostro (500).
app.use((err, req, res, next) => {
    if (err.type === 'entity.parse.failed') {
        return sendError(res, 400, 'invalid_json', 'The body is not valid JSON');
    }
    console.error(err);
    sendError(res, 500, 'server_error', 'Something went wrong');
});

app.listen(3000, () => {
    console.log('Task tracker API on port 3000');
});