REST vs zwykłe API - projektowanie endpointow

+----------+          HTTP          +----------+
|  Klient  | <------------------->  |  Serwer  |
| (React,  |   GET /users           |  (API)   |
|  Mobile) |   POST /users          |          |
|          |   PUT /users/123       |          |
+----------+   DELETE /users/123    +----------+
                    |
                    v
              +----------+
              |   JSON   |
              | Response |
              +----------+

ZLE (styl RPC):                    DOBRZE (styl REST):
POST /createUser                   POST /users
GET /getUserById?id=123            GET /users/123
POST /updateUser                   PUT /users/123
POST /deleteUser?id=123            DELETE /users/123
GET /getAllUserPosts?userId=123    GET /users/123/posts

// GET /users
// Status: 200 OK

{
  "data": [
    {
      "id": 1,
      "name": "Jan Kowalski",
      "email": "jan@example.com"
    },
    {
      "id": 2,
      "name": "Anna Nowak",
      "email": "anna@example.com"
    }
  ],
  "meta": {
    "total": 2,
    "page": 1,
    "per_page": 10
  }
}

// POST /users
// Body: { "name": "Piotr Wisniewski", "email": "piotr@example.com" }
// Status: 201 Created

{
  "data": {
    "id": 3,
    "name": "Piotr Wisniewski",
    "email": "piotr@example.com",
    "created_at": "2024-01-15T10:30:00Z"
  }
}

// GET /users/999
// Status: 404 Not Found

{
  "error": {
    "code": "NOT_FOUND",
    "message": "Użytkownik o ID 999 nie istnieje",
    "details": null
  }
}

// POST /users
// Body: { "name": "", "email": "nieprawidłowy-email" }
// Status: 422 Unprocessable Entity

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "Dane wejsciowe sa nieprawidłowe",
    "details": {
      "name": ["Pole name jest wymagane"],
      "email": ["Nieprawidłowy format adresu email"]
    }
  }
}

// Filtrowanie
GET /products?category=electronics&price_min=100&price_max=500

// Sortowanie
GET /products?sort=price&order=asc

// Paginacja
GET /products?page=2&per_page=20

// Kombinacja
GET /products?category=electronics&sort=price&order=desc&page=1&per_page=10