Endpoints

Описание конечных точек приложения

Конечные точки пользователей

---

Конечные точки платформы

---

Конечные точки курсов

Создание курса

• Путь: /api/create-course
• Метод: POST
• Параметры тела запроса:
  • course_title (string) – наименование курса
  • description (string) – описание курса
  • author (string) – автор курса
• Тело запроса:

  {
    "title": "Интенсивный курс HIIT",
    "description": "Курс с высокоинтенсивными интервальными тренировками",
    "author": "Иванова Мария"
  }

• Ответ: JSON-документ с информацией о созданном курсе, ID (в формате UUID) созданного курса:
• Пример ответа:

  {
    "course_id": "26bda06d-bb5e-4b4b-91cb-6b05e4cfac2c",
    "title": "Интенсивный курс HIIT",
    "description": "Курс с высокоинтенсивными интервальными тренировками",
    "author": "Иванова Мария"
  }
  

Удаление курса

• Путь: /api/delete-course
• Метод: DELETE
• Параметры тела запроса:
  • course_id (string,uuid) – ID курса
• Тело запроса:

  {
  "course_id": "26bda06d-bb5e-4b4b-91cb-6b05e4cfac2c",
  }
  

• Ответ: JSON-документ с идентификатором удаленного курса:

  {
    "course_id": "26bda06d-bb5e-4b4b-91cb-6b05e4cfac2c",
    "message": "Курс успешно удален"
  }
  

Добавление модуля

• Путь: /api/courses/{course_id}/modules/add
• Метод: POST
• Параметры пути:
  • course_id (string) – идентификатор курса, к которому будет добавлен модуль
• Параметры тела запроса:
  • module_title (string) – наименование модуля
• Тело запроса:

  {
  "module_title": "Введение в HIIT"
  }

• Ответ: JSON-документ с информацией о добавленном модуле:
• Пример ответа:

  {
     "module_id": "26bda06d-bb5e-4b4b-91cb-6b05e4caac4c",
     "title": "Введение в HIIT",
     "course_id": "26bda06d-bb5e-4b4b-91cb-6b05e4cfac2c"
  }
  

Удаление модуля

• Путь: /api/courses/{course_id}/modules/{module_id}/delete

• Метод: DELETE

• Параметры пути:

  • course_id (string) – идентификатор курса, к которому будет добавлен модуль
  • module_id (string) – идентификатор удаляемого модуля

• Пример запроса DELETE /api/courses/26bda06d-bb5e-4b4b-91cb-6b05e4cfac2c /modules/26bda06d-bb5e-4b4b-91cb-6b05e4caac4c/delete

• Ответ: JSON-документ c идентификатором удаленного модуля и сообщением:

• Пример ответа:

  {
     "module_id": "26bda06d-bb5e-4b4b-91cb-6b05e4caac4c",
     "message": "Модуль успешно удален из курса"
  }