vlad-bb / project-team_1 Goto Github PK

Опис REST API для застосунку “PhotoShare”

Вступ

Застосунок “PhotoShare” надає можливість користувачам завантажувати, переглядати та коментувати світлини. API розроблено з використанням фреймворку FastAPI, що забезпечує швидке та ефективне виконання HTTP запитів.

Аутентифікація

Аутентифікація в “PhotoShare” API забезпечується через токени, що видаються після успішної авторизації користувача. Процес включає наступні кроки:

Реєстрація користувача:

POST /users/register Поля: username, password, email Результат: Повідомлення про успішну реєстрацію або помилки валідації. Вхід (Логін): POST /users/login Поля: username, password Результат: Токен аутентифікації, який використовується для авторизації подальших запитів.

Робота зі світлинами

Застосунок надає можливість завантажувати нові світлини, переглядати існуючі, а також видаляти їх. Кожна операція вимагає аутентифікації.

Завантаження світлини:

POST /photos Запит має містити multipart/form-data з файлом світлини. Результат: URL завантаженої світлини та інформація про неї. Перегляд світлини: GET /photos/{photo_id} Результат: Деталі світлини та URL для перегляду. Видалення світлини: DELETE /photos/{photo_id} Результат: Повідомлення про успішне видалення або помилку, якщо світлину не знайдено або користувач не має до неї прав.

Коментування

Коментування дозволяє користувачам взаємодіяти зі світлинами через текстові коментарі.

Додавання коментаря:

POST /photos/{photo_id}/comments Поля: text Результат: Деталі доданого коментаря. Перегляд коментарів до світлини: GET /photos/{photo_id}/comments Результат: Список всіх коментарів до світлини. Видалення коментаря: DELETE /comments/{comment_id} Результат: Повідомлення про успішне видалення коментаря або помилку, якщо коментар не знайдено.

Заключення

API застосунку “PhotoShare” використовує стандарти REST для забезпечення простоти та зручності взаємодії. Завдяки швидкості та надійності FastAPI, “PhotoShare” є ефективним інструментом для обміну світлинами та комунікації між користувачами.