Wersjonowanie

Część sekcji API REST ścieżki Node.js w Coddy. Lekcja 15 z 18.

Zmiana struktury odpowiedzi psuje działanie każdego klienta, który już z niej korzysta. Wersja w ścieżce pozwala starym i nowym klientom działać obok siebie: /api/v1/orders dziś, /api/v2/orders po zmianie struktury. Ścieżki, które zostały przeniesione, odpowiadają przekierowaniem:

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

Kody 301 i 302 pozwalają klientom ponowić żądanie POST jako GET, co powoduje utratę treści żądania. 308 oznacza „ponów tam to samo żądanie” — wraz z metodą i treścią. W zamontowanym oprogramowaniu pośredniczącym req.url nie zawiera już ścieżki montowania, a req.originalUrl zachowuje ją w całości:

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

Wyzwanie

Łatwy

Zamontuj router zadań pod adresem /api/v1/tasks.
Każda stara ścieżka /api/tasks odpowiada przekierowaniem 308 do tej samej ścieżki pod /api/v1, wraz z zapytaniem.
Nowe zadania otrzymują Location: /api/v1/tasks/<id>.

Wyślij GET /api/tasks/2, POST /api/tasks z { "title": "Order new chairs" }, a następnie GET /api/v1/tasks/2.

Spróbuj swoich sił

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());

// Umożliwia stronom z BOARD_ORIGIN wywoływanie tego API z przeglądarki.
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);

// Błędy z tras trafiają tutaj. Treść żądania, która nie jest poprawnym JSON, to
// błąd klienta (400); wszystko inne to nasz błąd (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');
});