Проєктування REST API

/books
/books/42

/users
/orders
/comments

GET /books
POST /books
DELETE /books/42

GET /getBooks
POST /createBook
POST /deleteBook/42

/api/v1/book-reviews

/api/BookReviews
/api/book_reviews
/api/bookReviews

GET /api/v1/books
GET /api/v1/books/42

POST /api/v1/books
Content-Type: application/json

{
  "title": "Кобзар",
  "author": "Тарас Шевченко"
}

PUT /api/v1/books/42
Content-Type: application/json

{
  "title": "Кобзар",
  "author": "Тарас Шевченко",
  "year": 1840
}

PATCH /api/v1/books/42
Content-Type: application/json

{
  "year": 1840
}

DELETE /api/v1/books/42

GET    /api/v1/books       # список книг
POST   /api/v1/books       # створення книги
GET    /api/v1/books/42    # одна книга
PATCH  /api/v1/books/42    # часткове оновлення
DELETE /api/v1/books/42    # видалення

GET /api/v1/books/42/reviews
POST /api/v1/books/42/reviews

/users/1/orders/2/items/3/reviews/4

/api/v1/books
/api/v2/books

{
  "title": "Кобзар",
  "author": "Тарас Шевченко"
}

{
  "id": 1,
  "title": "Кобзар",
  "author": "Тарас Шевченко"
}

[
  {
    "id": 1,
    "title": "Кобзар",
    "author": "Тарас Шевченко"
  },
  {
    "id": 2,
    "title": "Лісова пісня",
    "author": "Леся Українка"
  }
]

Content-Type: application/json

GET /api/v1/books?author=Shevchenko
GET /api/v1/books?limit=10&offset=20
GET /api/v1/books?sort=title

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Поле title є обов'язковим"
  }
}

const http = require('node:http');
const { URL } = require('node:url');

const books = [
  {
    id: 1,
    title: 'Кобзар',
    author: 'Тарас Шевченко',
  },
  {
    id: 2,
    title: 'Лісова пісня',
    author: 'Леся Українка',
  },
];

let nextId = 3;

function sendJson(response, statusCode, data, headers = {}) {
  response.writeHead(statusCode, {
    'Content-Type': 'application/json; charset=utf-8',
    ...headers,
  });

  response.end(JSON.stringify(data));
}

function sendError(response, statusCode, code, message) {
  sendJson(response, statusCode, {
    error: {
      code,
      message,
    },
  });
}

function readJsonBody(request) {
  return new Promise((resolve, reject) => {
    let body = '';

    request.on('data', (chunk) => {
      body += chunk;

      // Обмежуємо розмір тіла запиту одним мегабайтом.
      if (body.length > 1024 * 1024) {
        reject(new Error('REQUEST_TOO_LARGE'));
        request.destroy();
      }
    });

    request.on('end', () => {
      if (body.length === 0) {
        resolve({});
        return;
      }

      try {
        resolve(JSON.parse(body));
      } catch {
        reject(new Error('INVALID_JSON'));
      }
    });

    request.on('error', reject);
  });
}

const server = http.createServer(async (request, response) => {
  const url = new URL(
    request.url,
    `http://${request.headers.host || 'localhost'}`
  );

  const pathParts = url.pathname.split('/').filter(Boolean);

  // Підтримуємо лише URI виду /api/v1/books або /api/v1/books/:id.
  if (
    pathParts[0] !== 'api' ||
    pathParts[1] !== 'v1' ||
    pathParts[2] !== 'books' ||
    pathParts.length > 4
  ) {
    sendError(response, 404, 'NOT_FOUND', 'Маршрут не знайдено');
    return;
  }

  const id = pathParts.length === 4 ? Number(pathParts[3]) : null;

  if (id !== null && !Number.isInteger(id)) {
    sendError(response, 400, 'INVALID_ID', 'Ідентифікатор має бути цілим числом');
    return;
  }

  try {
    if (request.method === 'GET' && id === null) {
      sendJson(response, 200, books);
      return;
    }

    if (request.method === 'GET' && id !== null) {
      const book = books.find((item) => item.id === id);

      if (!book) {
        sendError(response, 404, 'BOOK_NOT_FOUND', 'Книгу не знайдено');
        return;
      }

      sendJson(response, 200, book);
      return;
    }

    if (request.method === 'POST' && id === null) {
      const data = await readJsonBody(request);

      if (
        typeof data.title !== 'string' ||
        data.title.trim() === '' ||
        typeof data.author !== 'string' ||
        data.author.trim() === ''
      ) {
        sendError(
          response,
          400,
          'VALIDATION_ERROR',
          'Поля title та author є обов’язковими'
        );
        return;
      }

      const book = {
        id: nextId++,
        title: data.title.trim(),
        author: data.author.trim(),
      };

      books.push(book);

      sendJson(response, 201, book, {
        Location: `/api/v1/books/${book.id}`,
      });
      return;
    }

    if (request.method === 'PATCH' && id !== null) {
      const book = books.find((item) => item.id === id);

      if (!book) {
        sendError(response, 404, 'BOOK_NOT_FOUND', 'Книгу не знайдено');
        return;
      }

      const data = await readJsonBody(request);

      if ('title' in data) {
        if (typeof data.title !== 'string' || data.title.trim() === '') {
          sendError(
            response,
            400,
            'VALIDATION_ERROR',
            'Поле title має бути непорожнім рядком'
          );
          return;
        }

        book.title = data.title.trim();
      }

      if ('author' in data) {
        if (typeof data.author !== 'string' || data.author.trim() === '') {
          sendError(
            response,
            400,
            'VALIDATION_ERROR',
            'Поле author має бути непорожнім рядком'
          );
          return;
        }

        book.author = data.author.trim();
      }

      sendJson(response, 200, book);
      return;
    }

    if (request.method === 'DELETE' && id !== null) {
      const bookIndex = books.findIndex((item) => item.id === id);

      if (bookIndex === -1) {
        sendError(response, 404, 'BOOK_NOT_FOUND', 'Книгу не знайдено');
        return;
      }

      books.splice(bookIndex, 1);

      response.writeHead(204);
      response.end();
      return;
    }

    sendError(
      response,
      405,
      'METHOD_NOT_ALLOWED',
      'Метод не підтримується для цього URI'
    );
  } catch (error) {
    if (error.message === 'INVALID_JSON') {
      sendError(response, 400, 'INVALID_JSON', 'Тіло запиту має бути коректним JSON');
      return;
    }

    if (error.message === 'REQUEST_TOO_LARGE') {
      sendError(response, 413, 'REQUEST_TOO_LARGE', 'Тіло запиту занадто велике');
      return;
    }

    console.error(error);
    sendError(response, 500, 'INTERNAL_ERROR', 'Внутрішня помилка сервера');
  }
});

server.listen(3000, () => {
  console.log('REST API працює на http://localhost:3000');
});

node server.js

curl http://localhost:3000/api/v1/books

curl http://localhost:3000/api/v1/books/1

curl -X POST http://localhost:3000/api/v1/books \
  -H "Content-Type: application/json" \
  -d '{"title":"Місто","author":"Валер’ян Підмогильний"}'

curl -X PATCH http://localhost:3000/api/v1/books/1 \
  -H "Content-Type: application/json" \
  -d '{"title":"Новий заголовок"}'

curl -X DELETE http://localhost:3000/api/v1/books/1

Ресурс: книга
URI: /api/v1/books
Метод: POST
Тіло: title, author
Успіх: 201 Created
Помилка неправильних даних: 400 Bad Request

POST /api/v1/createBook
POST /api/v1/deleteBook/1

POST /api/v1/books
DELETE /api/v1/books/1

{
  "message": "Помилка"
}

{
  "errorMessage": "Помилка"
}