ENGLISH

REST API Documentation

---

Introduction

This is a REST API server built using json-server library. It provides endpoints for managing products, orders, users, and authentication.

---

Prerequisites

• Node.js and npm should be installed on your system.

---

Installation

1. Clone the repository.
2. Navigate to the project directory.
3. Install dependencies by running the following command:

---

Usage

1. Start the server by running the following command:

The server will start running on the specified port (default: 3001).

---

2. API Endpoints:

   ---

• GET /products?type=:type

  • Description: Get products by type with optional filtering by minprice and maxprice.
  • Parameters:
    • type (string): The type of products to retrieve. Use "all" to get all products.
    • minprice (optional, number): The minimum price of products to retrieve.
    • maxprice (optional, number): The maximum price of products to retrieve.
  • Returns: An array of products matching the specified criteria.

  ---

• GET /products?id=:id

  • Description: Get a product by its ID.
  • Parameters:
    • id (string): The ID of the product.
  • Returns: The product object with the specified ID.

  ---

• GET /products?minprice=:minprice&maxprice=:maxprice

  • Description: Get products by price with optional filtering by type.
  • Tham số:
    • minprice (optional, number): The minimum price of products to retrieve.
    • maxprice (optional, number): The maximum price of products to retrieve.
  • Returns: An array of products matching the specified criteria.

  ---

• GET /products

  • Description: Get all products.
  • Returns: An array of products.

  ---

• POST /products

  • Description: Create a new product.
  • Headers: userid (string): The ID of the user creating the product. Authorization: Bearer accessToken (string): The user's access token.
  • Body: An object containing the information of the new product (name: String, type: String, category: String, quantity: Number, price: Number, images: File).
  • Response: An object with the message "New product added successfully!" and the created product.

  {
    "headers": {
      "authorization": "Bearer AaCcCcEeSsSsTtOoKkEeNn"
    },
    "body": {
      "name": "Test Product",
      "price": 1,
      "quantity": 1,
      "type": "used",
      "category": "phone",
      "images": [
        "data:image/jpeg;base64,/9j/Base64ImageStringFromInputTypeFile.png",
        "data:image/jpeg;base64,/9j/Base64ImageStringFromInputTypeFile.jpeg"
      ]
    },
    "result": {
      "message": "Thêm sản phẩm mới thành công!",
      "product": {
        "id": "test-product",
        "name": "Test Product",
        "type": "used",
        "category": "phone",
        "quantity": 1,
        "price": 1,
        "images": [
          "/images/test-product/test-product-{random}.png",
          "/images/test-product/test-product-{random}.jpeg"
        ]
      }
    }
  }

  ---

• PUT /products?id=:id

  • Description: Update product information.

  • Header: userid (string): The ID of the user updating the product. Authorization: Bearer accessToken (string): The user's access token.

  • Body: An object containing the information to update the product (name: String, type: String, category: String, quantity: Number, price: Number, images: File).

    • It can include some or all of the product attributes.

  • Response: An object with the message "Product updated successfully!" and the updated product.

  {
    "headers": {
      "authorization": "Bearer AaCcCcEeSsSsTtOoKkEeNn"
    },
    "body": {
      "name": "Hello world" // Berfore: "Test Product"
    },
    "result": {
      "message": "Thêm sản phẩm mới thành công!",
      "product": {
        "id": "test-product",
        "name": "Hello world",
        "type": "used",
        "category": "phone",
        "quantity": 1,
        "price": 1,
        "images": [
          "/images/test-product/test-product-{random}.png",
          "/images/test-product/test-product-{random}.jpeg"
        ]
      }
    }
  }

  ---

• DELETE /products?id=:id

  • Description: Delete a product by its ID.
  • Header: userid (string): The ID of the user deleting the product. Authorization: Bearer accessToken (string): The user's access token.
  • Query:
    • id (string): The ID of the product.
  • Response: An object with the message "Product deleted successfully!" and the deleted product.

  ---

• GET /orders?userid=userid

  • Description: Get orders with optional filtering by userid or orderid.(requires authentication).
  • Parameters:
    • userid (optional, string): Filter orders by user ID.
  • Returns: An object containing the orders matching the specified criteria.

  {
    "headers": {
      "Authorization": "Bearer AaCcEeSsTtOoKkEeNn"
    },
    "result": {
      "message": "Lấy thông tin đơn hàng thành công!",
      "orders": [
        {
          "id": "OoRrDdEeRrIiDd",
          "totalPrices": 2998,
          "totalProducts": 2,
          "status": "Đang xử lý",
          "products": [
            {
              "id": "PpRrOoDdUuCcTtIiDd1",
              "name": "Huawei Matebook X Pro",
              "type": "new",
              "category": "laptop",
              "quantity": 2,
              "price": 1499,
              "images": [
                "/images/huawei-matebook-x-pro/huawei-matebook-x-pro.webp",
                "/images/huawei-matebook-x-pro/huawei-matebook-x-pro2.webp"
              ]
            }
          ],
          "user": {
            "name": "Nguyen Duong",
            "email": "duongcoilc2004@gmail.com",
            "address": "197 Tran Phu, Ha Dong, Ha Noi, Viet Nam",
            "phone": "0986921104"
          }
        }
      ]
    }
  }

  ---

• GET /orders?orderid=:orderid

  • Description: Get orders with optional filtering by userid or orderid.(requires authentication).
  • Parameters:
    • orderid (optional, string): Get a specific order by its ID.
  • Returns: An object containing the orders matching the specified criteria.

  {
    "headers": {
      "Authorization": "Bearer AaCcEeSsTtOoKkEeNn"
    },
    "result": {
      "message": "Lấy thông tin đơn hàng thành công!",
      "id": "OoRrDdEeRrIiDd",
      "status": "Đang xử lý",
      "products": [
        {
          "id": "PpRrOoDdUuCcTtIiDd1",
          "name": "Huawei Matebook X Pro",
          "type": "new",
          "category": "laptop",
          "quantity": 3,
          "price": 1499,
          "images": [
            "/images/huawei-matebook-x-pro/huawei-matebook-x-pro.webp",
            "/images/huawei-matebook-x-pro/huawei-matebook-x-pro2.webp"
          ]
        }
      ],
      "user": {
        "name": "User Name",
        "email": "example@gmail.com",
        "address": "Address",
        "phone": "0123456789"
      },
      "totalPrices": 4497,
      "totalProducts": 3
    }
  }

  ---

• POST /orders

  • Description: Create a new order.(requires authentication).
  • Request Body:
    • items (array): An array of objects representing the items to order. Each item should have productid and quantity properties.
  • Returns: An object with the message "Đặt hàng thành công!" and the created order.

  {
    "headers": {
      "userid": "UuSsEeRrIiDd"
    },
    "body": {
      "items": [
        {
          "productid": "PpRrOoDdUuCcTtIiDd1",
          "quantity": 1
        },
        {
          "productid": "PpRrOoDdUuCcTtIiDd2",
          "quantity": 22
        },
        {
          "productid": "PpRrOoDdUuCcTtIiDd3",
          "quantity": 333
        }
      ]
    },
    "result": {
      "message": "Đặt hàng thành công!",
      "orders": [
        {
          "id": "OoRrDdEeRrIiDd",
          "productid": [
            "PpRrOoDdUuCcTtIiDd1",
            "PpRrOoDdUuCcTtIiDd2",
            "PpRrOoDdUuCcTtIiDd3"
          ],
          "quantity": [1, 22, 33],
          "totalPrice": 46544,
          "status": "Đang xử lý"
        }
      ]
    }
  }

  ---

• GET /users/:userid

  • Description: Get a user by their ID.(requires authentication).
  • Parameters:
    • id (string): The ID of the user.
  • Returns: The user object with the specified ID (excluding the password).

  ---

• PATCH /users/:userid

  • Description: Update a user's information.(requires authentication).
  • Parameters:
    • id (string): The ID of the user to update.
  • Request Body: An object containing the updated user information (name, address, phone, email).
  • Returns: An object with the message "Cập nhật thông tin thành công!" and the updated user.

  ---

• POST /admins/create

  • Description: Create a new admin user (requires authentication).
  • Request Body: An object containing the new admin's information (username, password, role, address, phone, name, email).
  • Returns: An object with the message "Tạo admin mới thành công!" and the created admin.

  {
    "headers": {
      "username": "AaDdMmIiNnUuSsEeRrNnAaMmEe",
      "password": "A@aDdMmIiNnPpAaSsSsWwOoRrDd"
    },
    "body": {
      "username": "AaDdMmIiNnUuSsEeRrNnAaMmEe2",
      "password": "A@aDdMmIiNnPpAaSsSsWwOoRrDd2",
      "address": "Address",
      "phone": "0123456789",
      "name": "Admin 2",
      "email": "admin@example.com"
    },
    "result": {
      "message": "Tạo admin mới thành công!",
      "admin": {
        "id": "AaDdMmIiNnUuSsEeRrIiDd",
        "username": "AaDdMmIiNnUuSsEeRrNnAaMmEe2",
        "address": "Address",
        "email": "admin@example.com",
        "phone": "0123456789",
        "name": "Admin 2",
        "role": "admin"
      }
    }
  }

  ---

• POST /admins/hard-reset

  • Description: Reset the database to its initial state (requires authentication).
  • Request Body: An object containing the new admin's information (username, password, userid, accessToken).
  • Returns: An object with the message "Restore data thành công!" and the database has been reset.

  ---

• POST /auth/login

  • Description: Authenticate a user and generate a token for further API calls.
  • Request Body: An object containing the user's username and password.
  • Returns: An object with the message “login successful!” and authenticated user information, including access token.

  {
    "body": {
      "username": "AaDdMmIiNnUuSsEeRrNnAaMmEe2",
      "password": "A@aDdMmIiNnPpAaSsSsWwOoRrDd2"
    },
    "result": {
      "message": "Đăng nhập thành công!",
      "user": {
        "id": "AaDdMmIiNnUuSsEeRrIiDd2",
        "username": "AaDdMmIiNnUuSsEeRrNnAaMmEe2",
        "address": "Address",
        "email": "admin@example.com",
        "phone": "0123456789",
        "name": "Admin 2",
        "role": "admin"
      },
      "accessToken": "AaCcEeSsTtOoKkEeNn",
      "refreshToken": "RrEeFfRrEeSsHhTtOoKkEeNn"
    }
  }

  ---

• POST /auth/register

  • Description: Create a new user account.
  • Request Body: An object containing the new user's information (username, password, name, email, address, phone).
  • Returns: An object with the message “account registration successful!” and the created user, including access token and refresh token.

  {
    "body": {
      "username": "user",
      "password": "user",
      "name": "Nguyen Duong",
      "email": "email@example.com",
      "address": "Address",
      "phone": "0987654321"
    },
    "result": {
      "message": "Đăng ký tài khoản thành công!",
      "user": {
        "id": "UuSsEeRrIiDd",
        "username": "user",
        "name": "Nguyen Duong",
        "email": "email@example.com",
        "address": "Address",
        "phone": "0987654321",
        "role": "user"
      },
      "accessToken": "AaCcEeSsTtOoKkEeNn",
      "refreshToken": "RrEeFfRrEeSsHhTtOoKkEeNn"
    }
  }

  ---

• POST /auth/auth-token

  Description: Automatically log in the user using Authorization: Bearer AccessToken.

  Parameters:

  • Header: authorization Bearer userid (string): The user’s ID. accessToken (string): The user’s access token.

  • Result: An object with the message “Automatic login successful!” and authenticated user information.

  {
    "headers": {
      "Authorization": "Bearer AaCcEeSsTtOoKkEeNn",
      "userid": "UuSsEeRrIiDd"
    },
    "result": {
      "message": "Đăng nhập tự động thành công!",
      "user": {
        "id": "UuSsEeRrIiDd",
        "username": "UuSsEeRrNnAaMmEe",
        "address": "AaDdDdRrEeSsSs",
        "email": "EeMmAaIiLl@email.com",
        "phone": "0987654321",
        "name": "MmYy NnAaMmEe",
        "role": "user"
      }
    }
  }

  ---

• POST /auth/refresh-token

  Description: Generate a new access token for the user.

  Parameters:

  • Header: authorization Bearer refreshToken (string): The user’s refresh token.

  • Body: userid (string): The user’s ID. accessToken (string): The user’s old access token.

  • Result: An object with the message “Token refresh successful!” and the new access token.

    {
      "headers": {
        "Authorization": "Bearer RrEeFfRrEeSsHhTtOoKkEeNn",
        "userid": "UuSsEeRrIiDd"
      },
      "body": {
        "accessToken": "PreviousAaCcEeSsTtOoKkEeNn"
      },
      "result": {
        "message": "Refresh token thành công!",
        "accessToken": "NewAaCcEeSsTtOoKkEeNn"
      }
    }

---

3. Authorization:

• Some endpoints require authentication. Use the /login endpoint to obtain a token, and include it in the Authorization header for authenticated requests.

---

Notes

• The server uses a JSON file (db.json) as a database for storing products, orders, and users.
• The server supports basic CRUD operations for managing the data.
• Some endpoints require authentication and authorization based on user roles.

---

Heed

Except for the following endpoints, all other endpoints require authentication userid and Authorization: Bearer accessToken header.

---

• GET /products?type=:type

  ---

• GET /products?id=:id

  ---

• POST /login

  ---

• POST /register

  ---

• POST /auth-token

  ---

• POST /refresh-token

  ---

• GET /assets/:path

  ---

• GET /images/:path

  ---

• GET /api

  ---

• GET /

VIETNAMESE

Tài liệu REST API

---

Giới thiệu

Đây là một máy chủ REST API được xây dựng bằng thư viện json-server. Nó cung cấp các điểm cuối để quản lý sản phẩm, đơn hàng, người dùng và xác thực.

---

Yêu cầu tiên quyết

• Bạn cần cài đặt Node.js và npm trên hệ thống của bạn.

---

Cài đặt

1. Sao chép kho lưu trữ.
2. Di chuyển đến thư mục dự án.
3. Cài đặt các phụ thuộc bằng cách chạy lệnh sau:

---

Sử dụng

1. Khởi động máy chủ bằng cách chạy lệnh sau:

Máy chủ sẽ bắt đầu chạy trên cổng đã chỉ định (mặc định: 3001).

---

2. Điểm cuối API:

   ---

• GET /products?type=:type

  • Mô tả: Lấy các sản phẩm theo loại với khả năng lọc tùy chọn bằng minprice và maxprice.
  • Tham số:
    • type (string): Loại sản phẩm cần lấy. Sử dụng "all" để lấy tất cả sản phẩm.
    • minprice (tùy chọn, số): Giá tối thiểu của sản phẩm cần lấy.
    • maxprice (tùy chọn, số): Giá tối đa của sản phẩm cần lấy.
  • Kết quả: Một mảng các sản phẩm phù hợp với các tiêu chí đã chỉ định.

  ---

• GET /products?id=:id

  • Mô tả: Lấy một sản phẩm bằng ID của nó.
  • Tham số:
    • id (string): ID của sản phẩm.
  • Kết quả: Đối tượng sản phẩm có ID đã chỉ định.

• GET /products?minprice=:minprice&maxprice=:maxprice

  • Mô tả: Lấy các sản phẩm với khả năng lọc tùy chọn bằng minprice và maxprice.
  • Tham số:
    • minprice (tùy chọn, số): Giá tối thiểu của sản phẩm cần lấy.
    • maxprice (tùy chọn, số): Giá tối đa của sản phẩm cần lấy.
  • Kết quả: Một mảng các sản phẩm phù hợp với các tiêu chí đã chỉ định.

  ---

• GET /products

  • Mô tả: Lấy tất cả sản phẩm.
  • Kết quả: Một mảng các sản phẩm.

  ---

• POST /products

  • Mô tả: Tạo sản phẩm mới.
  • Header: userid (string): ID của người dùng tạo sản phẩm. Authorization: Bearer accessToken (string): Mã thông báo truy cập của người dùng.
  • Body: Đối tượng chứa thông tin sản phẩm mới (name: String, type: String, category: String, quantity: Number, price: Number, images: File).
  • Kết quả: Một đối tượng với thông báo "Thêm sản phẩm mới thành công!" và sản phẩm đã được tạo.

  {
    "headers": {
      "authorization": "Bearer AaCcCcEeSsSsTtOoKkEeNn"
    },
    "body": {
      "name": "Test Product",
      "price": 1,
      "quantity": 1,
      "type": "used",
      "category": "phone",
      "images": [
        "data:image/jpeg;base64,/9j/Base64ImageStringFromInputTypeFile.png",
        "data:image/jpeg;base64,/9j/Base64ImageStringFromInputTypeFile.jpeg"
      ]
    },
    "result": {
      "message": "Thêm sản phẩm mới thành công!",
      "product": {
        "id": "test-product",
        "name": "Test Product",
        "type": "used",
        "category": "phone",
        "quantity": 1,
        "price": 1,
        "images": [
          "/images/test-product/test-product-{random}.png",
          "/images/test-product/test-product-{random}.jpeg"
        ]
      }
    }
  }

  ---

• PUT /products?id=:id

  • Mô tả: Cập nhật thông tin sản phẩm.

  • Header: userid (string): ID của người dùng cập nhật sản phẩm. Authorization: Bearer accessToken (string): Mã thông báo truy cập của người dùng.

  • Body: Đối tượng chứa thông tin sản phẩm cần cập nhật (name: String, type: String, category: String, quantity: Number, price: Number, images: File).

    • Có thể bao gồm một số thuộc tính hoặc tất cả các thuộc tính của sản phẩm.

  • Kết quả: Một đối tượng với thông báo "Cập nhật sản phẩm thành công!" và sản phẩm đã cập nhật.

  {
    "headers": {
      "authorization": "Bearer AaCcCcEeSsSsTtOoKkEeNn"
    },
    "body": {
      "name": "Hello world" // Berfore: "Test Product"
    },
    "result": {
      "message": "Thêm sản phẩm mới thành công!",
      "product": {
        "id": "test-product",
        "name": "Hello world",
        "type": "used",
        "category": "phone",
        "quantity": 1,
        "price": 1,
        "images": [
          "/images/test-product/test-product-{random}.png",
          "/images/test-product/test-product-{random}.jpeg"
        ]
      }
    }
  }

  ---

• DELETE /products?id=:id

  • Mô tả: Xóa sản phẩm bằng ID của nó.
  • Header: userid (string): ID của người dùng xóa sản phẩm. Authorization: Bearer accessToken (string): Mã thông báo truy cập của người dùng.
  • Tham số:
    • id (string): ID của sản phẩm.
  • Kết quả: Một đối tượng với thông báo "Xóa sản phẩm thành công!" và sản phẩm đã xóa.

  ---

---

• GET /orders?userid=:userid

  • Mô tả: Lấy đơn hàng với khả năng lọc tùy chọn bằng userid(yêu cầu xác thực).
  • Tham số:
    • userid (tùy chọn, string): Lọc đơn hàng theo ID người dùng.
  • Kết quả: Một Object chứa một mảng các đơn hàng phù hợp với các tiêu chí đã chỉ định.

  {
    "headers": {
      "Authorization": "Bearer AaCcEeSsTtOoKkEeNn"
    },
    "result": {
      "message": "Lấy thông tin đơn hàng thành công!",
      "orders": [
        {
          "id": "OoRrDdEeRrIiDd",
          "totalPrices": 2998,
          "totalProducts": 2,
          "status": "Đang xử lý",
          "products": [
            {
              "id": "PpRrOoDdUuCcTtIiDd1",
              "name": "Huawei Matebook X Pro",
              "type": "new",
              "category": "laptop",
              "quantity": 2,
              "price": 1499,
              "images": [
                "/images/huawei-matebook-x-pro/huawei-matebook-x-pro.webp",
                "/images/huawei-matebook-x-pro/huawei-matebook-x-pro2.webp"
              ]
            }
          ],
          "user": {
            "name": "Nguyen Duong",
            "email": "duongcoilc2004@gmail.com",
            "address": "197 Tran Phu, Ha Dong, Ha Noi, Viet Nam",
            "phone": "0986921104"
          }
        }
      ]
    }
  }

  ---

• GET /orders?orderid=:orderid

  • Mô tả: Lấy đơn hàng với khả năng lọc tùy chọn bằng orderid(yêu cầu xác thực).
  • Tham số:
    • orderid (tùy chọn, string): Lọc đơn hàng theo ID người dùng.
  • Kết quả: Một Object chứa một mảng các đơn hàng phù hợp với các tiêu chí đã chỉ định.

  {
    "headers": {
      "Authorization": "Bearer AaCcEeSsTtOoKkEeNn"
    },
    "result": {
      "message": "Lấy thông tin đơn hàng thành công!",
      "id": "OoRrDdEeRrIiDd",
      "status": "Đang xử lý",
      "products": [
        {
          "id": "PpRrOoDdUuCcTtIiDd1",
          "name": "Huawei Matebook X Pro",
          "type": "new",
          "category": "laptop",
          "quantity": 3,
          "price": 1499,
          "images": [
            "/images/huawei-matebook-x-pro/huawei-matebook-x-pro.webp",
            "/images/huawei-matebook-x-pro/huawei-matebook-x-pro2.webp"
          ]
        }
      ],
      "user": {
        "name": "User Name",
        "email": "example@gmail.com",
        "address": "Address",
        "phone": "0123456789"
      },
      "totalPrices": 4497,
      "totalProducts": 3
    }
  }

  ---

• POST /orders

  • Mô tả: Tạo đơn hàng mới (yêu cầu xác thực).
  • Body Yêu Cầu:
    • items (mảng): Một mảng các đối tượng đại diện cho các mục để đặt hàng. Mỗi mục phải có các thuộc tính productid và quantity.
  • Kết quả: Một đối tượng với thông báo "Đặt hàng thành công!" và đơn hàng đã được tạo.

  {
    "headers": {
      "userid": "UuSsEeRrIiDd"
    },
    "body": {
      "items": [
        {
          "productid": "PpRrOoDdUuCcTtIiDd1",
          "quantity": 1
        },
        {
          "productid": "PpRrOoDdUuCcTtIiDd2",
          "quantity": 22
        },
        {
          "productid": "PpRrOoDdUuCcTtIiDd3",
          "quantity": 333
        }
      ]
    },
    "result": {
      "message": "Đặt hàng thành công!",
      "orders": [
        {
          "id": "OoRrDdEeRrIiDd",
          "productid": [
            "PpRrOoDdUuCcTtIiDd1",
            "PpRrOoDdUuCcTtIiDd2",
            "PpRrOoDdUuCcTtIiDd3"
          ],
          "quantity": [1, 22, 33],
          "totalPrice": 46544,
          "status": "Đang xử lý"
        }
      ]
    }
  }

  ---

• GET /users/:userid

  • Mô tả: Lấy thông tin người dùng bằng ID (yêu cầu xác thực).
  • Tham số:
    • id (string): ID của người dùng.
  • Kết quả: Đối tượng người dùng có ID đã chỉ định (loại trừ mật khẩu).

  ---

• PATCH /users/:userid

  • Mô tả: Cập nhật thông tin người dùng (yêu cầu xác thực).
  • Tham số:
    • id (string): ID của người dùng cần cập nhật.
  • Body: Đối tượng chứa thông tin người dùng đã cập nhật (name, address, phone, email).
  • Kết quả: Một đối tượng với thông báo "Cập nhật thông tin thành công!" và người dùng đã cập nhật.

  ---

• POST /admins/create

  • Mô tả: Tạo người dùng quản trị mới (yêu cầu xác thực).
  • Body: Đối tượng chứa thông tin người dùng quản trị mới (username, password, role, address, phone, name, email).
  • Kết quả: Một đối tượng với thông báo "Tạo admin mới thành công!" và người dùng quản trị đã được tạo.

  {
    "headers": {
      "username": "AaDdMmIiNnUuSsEeRrNnAaMmEe",
      "password": "A@aDdMmIiNnPpAaSsSsWwOoRrDd"
    },
    "body": {
      "username": "AaDdMmIiNnUuSsEeRrNnAaMmEe2",
      "password": "A@aDdMmIiNnPpAaSsSsWwOoRrDd2",
      "address": "Address",
      "phone": "0123456789",
      "name": "Admin 2",
      "email": "admin@example.com"
    },
    "result": {
      "message": "Tạo admin mới thành công!",
      "admin": {
        "id": "AaDdMmIiNnUuSsEeRrIiDd",
        "username": "AaDdMmIiNnUuSsEeRrNnAaMmEe2",
        "address": "Address",
        "email": "admin@example.com",
        "phone": "0123456789",
        "name": "Admin 2",
        "role": "admin"
      }
    }
  }

  ---

• POST /admins/hard-reset

  • Mô tả: Reset database về trạng thái ban đầu (yêu cầu xác thực).
  • Body: Đối tượng chứa thông tin người dùng quản trị (username, password, userid, accessToken).
  • Kết quả: Một đối tượng với thông báo "Restore data thành công!" và database đã được reset.

  ---

• POST /auth/login

  • Mô tả: Xác thực người dùng và tạo mã thông báo cho các cuộc gọi API tiếp theo.
  • Body: Đối tượng chứa username và password của người dùng.
  • Kết quả: Một đối tượng với thông báo "Đăng nhập thành công!" và thông tin người dùng đã được xác thực, bao gồm mã thông báo truy cập.

  {
    "body": {
      "username": "AaDdMmIiNnUuSsEeRrNnAaMmEe2",
      "password": "A@aDdMmIiNnPpAaSsSsWwOoRrDd2"
    },
    "result": {
      "message": "Đăng nhập thành công!",
      "user": {
        "id": "AaDdMmIiNnUuSsEeRrIiDd2",
        "username": "AaDdMmIiNnUuSsEeRrNnAaMmEe2",
        "address": "Address",
        "email": "admin@example.com",
        "phone": "0123456789",
        "name": "Admin 2",
        "role": "admin"
      },
      "accessToken": "AaCcEeSsTtOoKkEeNn",
      "refreshToken": "RrEeFfRrEeSsHhTtOoKkEeNn"
    }
  }

  ---

• POST /auth/register

  • Mô tả: Tạo tài khoản người dùng mới.
  • Body: Đối tượng chứa thông tin người dùng mới (username, password, name, email, address, phone).
  • Kết quả: Một đối tượng với thông báo "Đăng ký tài khoản thành công!" và người dùng đã được tạo, bao gồm mã thông báo truy cập và mã thông báo đặt lại.

  {
    "body": {
      "username": "user",
      "password": "user",
      "name": "Nguyen Duong",
      "email": "email@example.com",
      "address": "Address",
      "phone": "0987654321"
    },
    "result": {
      "message": "Đăng ký tài khoản thành công!",
      "user": {
        "id": "UuSsEeRrIiDd",
        "username": "user",
        "name": "Nguyen Duong",
        "email": "email@example.com",
        "address": "Address",
        "phone": "0987654321",
        "role": "user"
      },
      "accessToken": "AaCcEeSsTtOoKkEeNn",
      "refreshToken": "RrEeFfRrEeSsHhTtOoKkEeNn"
    }
  }

  ---

• POST /auth/auth-token

  Mô tả: Tự động đăng nhập người dùng bằng Authorization: Bearer AccessToken.

  Tham số:

  • Header: authorization Bearer userid (string): ID của người dùng. accessToken (string): Mã thông báo truy cập của người dùng.

  • Kết quả: Một đối tượng với thông báo "Đăng nhập tự động thành công!" và thông tin người dùng đã được xác thực.

  {
    "headers": {
      "Authorization": "Bearer AaCcEeSsTtOoKkEeNn",
      "userid": "UuSsEeRrIiDd"
    },
    "result": {
      "message": "Đăng nhập tự động thành công!",
      "user": {
        "id": "UuSsEeRrIiDd",
        "username": "UuSsEeRrNnAaMmEe",
        "address": "AaDdDdRrEeSsSs",
        "email": "EeMmAaIiLl@email.com",
        "phone": "0987654321",
        "name": "MmYy NnAaMmEe",
        "role": "user"
      }
    }
  }

  ---

• POST /auth/refresh-token

  Mô tả: Tạo lại mã thông báo truy cập mới cho người dùng. Tham số:

  • Header: authorization Bearer refreshToken (string): Mã thông báo đặt lại của người dùng.

  • Body: userid (string): ID của người dùng. accessToken (string): Mã thông báo truy cập cũ của người dùng.

  • Kết quả: Một đối tượng với thông báo "Tạo lại mã thông báo thành công!" và mã thông báo truy cập mới.

  {
    "headers": {
      "Authorization": "Bearer RrEeFfRrEeSsHhTtOoKkEeNn",
      "userid": "UuSsEeRrIiDd"
    },
    "body": {
      "accessToken": "PreviousAaCcEeSsTtOoKkEeNn"
    },
    "result": {
      "message": "Refresh token thành công!",
      "accessToken": "NewAaCcEeSsTtOoKkEeNn"
    }
  }

---

3. Xác thực:

• Một số điểm cuối yêu cầu xác thực. Sử dụng điểm cuối /login để lấy mã thông báo và bao gồm nó trong tiêu đề Authorization cho các yêu cầu được xác thực.

---

Ghi chú

• Máy chủ sử dụng một tệp JSON (db.json) làm cơ sở dữ liệu để lưu trữ sản phẩm, đơn hàng và người dùng.
• Máy chủ hỗ trợ các hoạt động CRUD cơ bản để quản lý dữ liệu.
• Một số điểm cuối yêu cầu xác thực và phân quyền dựa trên vai trò người dùng.

---

Lưu ý

Trừ những điểm cuối sau, mọi điểm cuối khác đều yêu cầu xác thực userid và Authorization: Bearer accessToken header.

• GET /products?type=:type

  ---

• GET /products?id=:id

  ---

• POST /login

  ---

• POST /register

  ---

• POST /auth-token

  ---

• POST /refresh-token

  ---

• GET /assets/:path

  ---

• GET /images/:path

  ---

• GET /api

  ---

• GET /