Task Manager API

Backend для системы управления задачами (Task Manager), позволяющей пользователям создавать проекты и управлять задачами внутри них. Разработан на FastAPI с использованием SQLite, JWT аутентификацией и SQLAlchemy 2.0+ с современным синтаксисом.

📋 Содержание

Технологический стек
Функциональность
Установка и запуск
Структура проекта
API Эндпоинты
Модели данных
Аутентификация
Миграции базы данных
Примеры запросов
Обработка ошибок
Переменные окружения
Развертывание

🛠 Технологический стек

FastAPI - современный веб-фреймворк для создания API
SQLite3 - легковесная база данных
SQLAlchemy 2.0+ - ORM с современным синтаксисом (Mapped / mapped_column)
JWT (python-jose) - JSON Web Tokens для аутентификации
Alembic - инструмент для миграций базы данных
Bcrypt (passlib) - хеширование паролей
Pydantic v2 - валидация данных и управление настройками

✨ Функциональность

Пользователи и аутентификация

✅ Регистрация новых пользователей с уникальными email и username
✅ Вход в систему с получением JWT токена (срок действия - 1 час)
✅ Защита паролей с помощью bcrypt хеширования
✅ Выход из системы (удаление токена на клиенте)

Проекты

✅ Создание проектов с названием и описанием
✅ Просмотр списка всех проектов пользователя
✅ Подсчет количества задач в каждом проекте
✅ Просмотр детальной информации о проекте со всеми задачами
✅ Сортировка проектов по дате создания (новые сверху)

Задачи

✅ Создание задач внутри проектов
✅ Назначение исполнителей задач (опционально)
✅ Три статуса задач: "todo", "in_progress", "done"
✅ Просмотр всех задач проекта
✅ Частичное обновление задач (PATCH)
✅ Удаление задач
✅ Автоматическое обновление поля updated_at при изменениях

Безопасность и права доступа

✅ Все эндпоинты (кроме регистрации и логина) защищены JWT
✅ Проверка прав доступа: пользователь может управлять только своими проектами
✅ Каскадное удаление задач при удалении проекта

🚀 Установка и запуск

Предварительные требования

Python 3.8 или выше
pip (менеджер пакетов Python)
virtualenv (рекомендуется)

Пошаговая установка

Клонируйте репозиторий:

git clone https://github.com/yourusername/task-manager-api.git
cd task-manager-api

Создайте и активируйте виртуальное окружение:

# Windows
python -m venv venv
venv\Scripts\activate

# Linux/Mac
python3 -m venv venv
source venv/bin/activate

Установите зависимости:

pip install -r requirements.txt

Создайте файл .env с настройками:

# Database
DATABASE_URL=sqlite:///./task_manager.db

# JWT Settings
SECRET_KEY=your-super-secret-key-change-in-production-2024
ALGORITHM=HS256
ACCESS_TOKEN_EXPIRE_MINUTES=60

Инициализируйте Alembic и создайте миграции:

# Инициализация Alembic (если еще не сделано)
alembic init alembic

# Создание первой миграции
alembic revision --autogenerate -m "Initial migration"

# Применение миграций
alembic upgrade head

Запустите сервер:

python run.py

Сервер будет доступен по адресу: http://localhost:8000

Доступ к документации

Документация Swagger: http://localhost:8000/docs
Документация ReDoc: http://localhost:8000/redoc
Главная страница API: http://localhost:8000

📁 Структура проекта

task-manager-api/
├── app/
│   ├── __init__.py
│   ├── main.py                 # Главный файл приложения
│   ├── models.py               # SQLAlchemy модели (Mapped стиль)
│   ├── schemas.py              # Pydantic схемы v2
│   ├── database.py             # Конфигурация базы данных
│   ├── auth.py                 # Функции аутентификации
│   ├── config.py               # Настройки приложения
│   ├── dependencies.py         # Зависимости FastAPI
│   ├── routers/
│   │   ├── __init__.py
│   │   ├── auth.py             # Роутер аутентификации
│   │   ├── projects.py         # Роутер проектов
│   │   └── tasks.py            # Роутер задач
│   └── alembic/                 # Миграции Alembic
│       ├── versions/
│       └── env.py
├── alembic.ini                  # Конфигурация Alembic
├── requirements.txt             # Зависимости проекта
├── .env                         # Переменные окружения
├── run.py                       # Скрипт для запуска
└── README.md                    # Документация

📚 API Эндпоинты

Аутентификация (Auth)

Метод	Эндпоинт	Описание	Требуется JWT
POST	`/auth/register`	Регистрация нового пользователя	Нет
POST	`/auth/login`	Вход в систему, получение JWT токена	Нет
POST	`/auth/logout`	Выход из системы	Да

Проекты (Projects)

Метод	Эндпоинт	Описание	Требуется JWT
GET	`/projects/`	Получение списка всех проектов пользователя	Да
POST	`/projects/`	Создание нового проекта	Да
GET	`/projects/{project_id}`	Получение детальной информации о проекте	Да

Задачи (Tasks)

Метод	Эндпоинт	Описание	Требуется JWT
GET	`/projects/{project_id}/tasks`	Получение всех задач проекта	Да
POST	`/projects/{project_id}/tasks`	Создание новой задачи в проекте	Да
PATCH	`/tasks/{task_id}`	Частичное обновление задачи	Да
DELETE	`/tasks/{task_id}`	Удаление задачи	Да

📊 Модели данных

User (Пользователь)

{
  "id": 1,
  "email": "user@example.com",
  "username": "john_doe",
  "created_at": "2024-01-01T12:00:00"
}

Project (Проект)

{
  "id": 1,
  "name": "Редизайн сайта",
  "description": "Обновление дизайна главной страницы",
  "owner_id": 1,
  "created_at": "2024-01-01T12:00:00",
  "updated_at": "2024-01-01T12:00:00",
  "task_count": 5
}

Task (Задача)

{
  "id": 1,
  "title": "Разработать макет",
  "description": "Создать Figma макет главной страницы",
  "status": "in_progress",
  "project_id": 1,
  "assignee_id": 2,
  "assignee_username": "jane_doe",
  "created_at": "2024-01-01T12:00:00",
  "updated_at": "2024-01-01T14:30:00"
}

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

API использует JWT (JSON Web Tokens) для аутентификации. После успешного входа вы получаете токен, который необходимо включать в заголовки всех защищенных запросов:

Authorization: Bearer <your_jwt_token>

Срок действия токена

Токен действителен в течение 1 часа (настраивается в .env)
По истечении срока необходимо получить новый токен через /auth/login

🔄 Миграции базы данных

Создание новой миграции

alembic revision --autogenerate -m "Описание изменений"

Применение миграций

alembic upgrade head

Откат миграции

alembic downgrade -1  # Откат на одну версию назад
alembic downgrade base  # Полный откат

Просмотр истории миграций

alembic history

Текущая версия

alembic current

📝 Примеры запросов

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

curl -X POST "http://localhost:8000/auth/register" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "username": "john_doe",
    "password": "securepassword123"
  }'

Ответ (201 Created):

{
  "id": 1,
  "email": "user@example.com",
  "username": "john_doe",
  "created_at": "2024-01-01T12:00:00"
}

Вход в систему

curl -X POST "http://localhost:8000/auth/login" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "user@example.com",
    "password": "securepassword123"
  }'

Ответ (200 OK):

{
  "access_token": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...",
  "token_type": "bearer"
}

Создание проекта (требуется JWT)

curl -X POST "http://localhost:8000/projects/" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Редизайн сайта",
    "description": "Обновление дизайна главной страницы"
  }'

Получение списка проектов

curl -X GET "http://localhost:8000/projects/" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Ответ (200 OK):

[
  {
    "id": 1,
    "name": "Редизайн сайта",
    "description": "Обновление дизайна главной страницы",
    "owner_id": 1,
    "created_at": "2024-01-01T12:00:00",
    "updated_at": null,
    "task_count": 3
  }
]

Создание задачи в проекте

curl -X POST "http://localhost:8000/projects/1/tasks" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Разработать макет",
    "description": "Создать Figma макет главной страницы",
    "assignee_id": 2
  }'

Обновление задачи (частичное)

curl -X PATCH "http://localhost:8000/tasks/1" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "status": "in_progress",
    "assignee_id": 3
  }'

Удаление задачи

curl -X DELETE "http://localhost:8000/tasks/1" \
  -H "Authorization: Bearer YOUR_JWT_TOKEN"

Ответ: 204 No Content

⚠️ Обработка ошибок

API возвращает стандартные HTTP статусы с понятными сообщениями:

Код	Описание	Пример ответа
400	Bad Request - неверные входные данные	`{"detail": "Email or username already registered"}`
401	Unauthorized - отсутствует или невалидный JWT	`{"detail": "Invalid authentication credentials"}`
403	Forbidden - недостаточно прав	`{"detail": "Not enough permissions. You are not the owner of this project"}`
404	Not Found - ресурс не найден	`{"detail": "Project not found"}`
500	Internal Server Error - внутренняя ошибка	`{"detail": "Internal server error"}`

🔧 Переменные окружения

Переменная	Описание	Значение по умолчанию
`DATABASE_URL`	URL подключения к БД	`sqlite:///./task_manager.db`
`SECRET_KEY`	Секретный ключ для JWT	`your-super-secret-key-change-in-production`
`ALGORITHM`	Алгоритм шифрования JWT	`HS256`
`ACCESS_TOKEN_EXPIRE_MINUTES`	Время жизни токена (в минутах)	`60`

🚀 Развертывание

Для разработки

# Установка зависимостей
pip install -r requirements.txt

# Запуск с автоматической перезагрузкой
python run.py

Для продакшена

# Установка зависимостей
pip install -r requirements.txt

# Запуск без автоматической перезагрузки
uvicorn app.main:app --host 0.0.0.0 --port 8000

🧪 Тестирование API с помощью Swagger

После запуска сервера откройте браузер и перейдите по адресу http://localhost:8000/docs. Вы увидите интерактивную документацию Swagger, где можете:

Просматривать все доступные эндпоинты
Тестировать API прямо в браузере
Видеть схемы запросов и ответов
Авторизоваться с помощью JWT токена (кнопка "Authorize")

📈 Особенности реализации

SQLAlchemy 2.0+ (Mapped стиль)

class User(Base):
    __tablename__ = "users"
    
    id: Mapped[int] = mapped_column(Integer, primary_key=True)
    email: Mapped[str] = mapped_column(String, unique=True)
    username: Mapped[str] = mapped_column(String, unique=True)

Pydantic v2 валидация

class TaskUpdate(BaseModel):
    title: Optional[str] = None
    status: Optional[str] = Field(None, pattern="^(todo|in_progress|done)$")

Зависимости для проверки прав

def get_project_or_404(project_id: int, db: Session, current_user: User) -> Project:
    project = db.query(Project).filter(Project.id == project_id).first()
    if not project or project.owner_id != current_user.id:
        raise HTTPException(status_code=403, detail="Not enough permissions")
    return project


```bash
# Клонирование и установка
git clone https://github.com/yourusername/task-manager-api.git
cd task-manager-api
python -m venv venv
source venv/bin/activate  # или venv\Scripts\activate на Windows
pip install -r requirements.txt

# Настройка базы данных
alembic revision --autogenerate -m "Initial migration"
alembic upgrade head

# Запуск
python run.py

После выполнения этих команд API будет доступно по адресу http://localhost:8000 🎉

Name		Name	Last commit message	Last commit date
Latest commit History 4 Commits
alembic		alembic
app		app
venv		venv
.env		.env
README.md		README.md
alembic.ini		alembic.ini
requirements.txt		requirements.txt
run.py		run.py
task_manager.db		task_manager.db

Folders and files

Latest commit

History

Repository files navigation

Task Manager API

📋 Содержание

🛠 Технологический стек

✨ Функциональность

Пользователи и аутентификация

Проекты

Задачи

Безопасность и права доступа

🚀 Установка и запуск

Предварительные требования

Пошаговая установка

Доступ к документации

📁 Структура проекта

📚 API Эндпоинты

Аутентификация (Auth)

Проекты (Projects)

Задачи (Tasks)

📊 Модели данных

User (Пользователь)

Project (Проект)

Task (Задача)

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

Срок действия токена

🔄 Миграции базы данных

Создание новой миграции

Применение миграций

Откат миграции

Просмотр истории миграций

Текущая версия

📝 Примеры запросов

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

Вход в систему

Создание проекта (требуется JWT)

Получение списка проектов

Создание задачи в проекте

Обновление задачи (частичное)

Удаление задачи

⚠️ Обработка ошибок

🔧 Переменные окружения

🚀 Развертывание

Для разработки

Для продакшена

🧪 Тестирование API с помощью Swagger

📈 Особенности реализации

SQLAlchemy 2.0+ (Mapped стиль)

Pydantic v2 валидация

Зависимости для проверки прав

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages