API REST документация для онлайн-магазина товаров для дома и сада

Общие Сведения

• Базовый URL: https://api.example.com/v1
• Формат данных: JSON
• Аутентификация: JWT токен в заголовке запроса Authorization: Bearer <token>

Эндпоинты

Управление учетными записями пользователей

• Регистрация пользователя

  • URL: /users/register

  • Метод: POST

  • Тело запроса:

    {
      "name": "string",
      "email": "string",
      "phone": "string",
      "password": "string"
    }
    

  • Ожидаемые HTTP статусы: 201 Created, 400 Bad Request

• Аутентификация пользователя

  • URL: /users/login

  • Метод: POST

  • Тело запроса:

    {
      "email": "string",
      "password": "string"
    }
    

  • Ожидаемые HTTP статусы: 200 OK, 401 Unauthorized

• Редактирование профиля пользователя

  • URL: /users/{userId}

  • Метод: PUT

  • Тело запроса:

    {
      "name": "string",
      "phone": "string"
    }
    

  • Ожидаемые HTTP статусы: 200 OK, 400 Bad Request, 404 Not Found

• Удаление учетной записи
  • URL: /users/{userId}
  • Метод: DELETE
  • Ожидаемые HTTP статусы: 200 OK, 404 Not Found

Управление каталогом товаров (для администраторов)

• Добавление нового товара

  • URL: /products

  • Метод: POST

  • Тело запроса:

    {
      "name": "string",
      "description": "string",
      "price": "number",
      "category": "string",
      "image": "string"
    }
    

  • Ожидаемые HTTP статусы: 201 Created, 400 Bad Request

• Редактирование товара

  • URL: /products/{productId}

  • Метод: PUT

  • Тело запроса:

    {
      "name": "string",
      "description": "string",
      "price": "number",
      "category": "string",
      "image": "string"
    }
    

  • Ожидаемые HTTP статусы: 200 OK, 400 Bad Request, 404 Not Found

• Удаление товара
  • URL: /products/{productId}
  • Метод: DELETE
  • Ожидаемые HTTP статусы: 200 OK, 404 Not Found

Управление категориями товаров (для администраторов)

• Добавление новой категории товаров

  • URL: /categories

  • Метод: POST

  • Тело запроса:

    {
      "categoryId": "string",
      "category": "string"
    }
    

  • Ожидаемые HTTP статусы: 201 Created, 400 Bad Request

• Редактирование категории товаров

  • URL: /categories/{categoryId}

  • Метод: PUT

  • Тело запроса:

    {
      "categoryId": "string",
      "category": "string"
    }
    

  • Ожидаемые HTTP статусы: 200 OK, 400 Bad Request, 404 Not Found

• Удаление категории товаров
  • URL: /categories/{categoryId}
  • Метод: DELETE
  • Ожидаемые HTTP статусы: 200 OK, 404 Not Found

Получение и Фильтрация Данных