Tasker API - REST API для управления задачами

Содержание

Описание предметной области

Сущности и связи

Основные возможности

Хороший API

Версионность

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

Идемпотентность

Rate Limiting

Пагинация

Опциональные поля (Field Selection)

Внутренний API (Internal API)

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

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

Требования

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

Вариант 1: Запуск с Docker Compose (рекомендуется)

Вариант 2: Локальный запуск (без Docker)

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

Документация API

Базовый URL

Основные эндпоинты

Аутентификация (без версионирования)

Проекты (V1 и V2)

Задачи V1

Задачи V2 (расширенная версия)

Версионность API

API сложно менять - Почему важна версионность

Реализованные версии

V1 (версия 1.0)

V2 (версия 2.0)

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

Выбор JWT - Обоснование

Использование JWT

Идемпотентность

Как работает

Использование

Преимущества

Rate Limiting

Лимиты

Заголовки ответа

При превышении лимита

Идентификация клиента

Примеры использования

1. Регистрация и создание задачи

2. Использование пагинации

3. Опциональные поля (Field Selection)

4. Использование V2 с тегами и оценкой времени

3. Полный CRUD цикл для задачи

5. Использование Internal API (для внутренних сервисов)

📄 Пагинация

Использование

Метаданные пагинации

Выбор подхода: Offset-based pagination

Опциональные поля (Field Selection)

Использование

Преимущества

Пример

Какие поля можно исключить

Внутренний API

Назначение

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

Основные endpoint'ы

Почему эти endpoint'ы внутренние?

Дополнительная документация

Ключевые компоненты

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

Получение всех задач с фильтрацией

Создание задачи (V2 с тегами)

Статистика по задачам (V2)

Безопасность

Тестирование

Lab3 - Интеграция с чужим API

Что реализовано

Документация Lab3

Быстрый старт Lab3

Структура Lab3

Основные возможности клиента

Оценка API