Лабораторная работа №3: Изучение чужого API

Задание

1. Изучение чужого API

2. Разработка клиента

3. Анализ API

4. Документация клиента

5. Отчёт

Отчёт

Ссылка на API

Описание клиента

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

Lab1 API (v1/v2)

Lab2 API (v3)

Запуск

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

Запуск примеров клиента

Анализ API

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

Недостатки

Предложения по улучшению

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

Lab1 API (v1/v2)

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

2. Вход (получение JWT токена)

3. Создание проекта с идемпотентностью

4. Создание задачи с приоритетом (API v2)

Lab2 API (v3)

5. Получение проектов с Sparse Fieldsets

Проблемы и их решения

1. Конфликт портов Docker контейнеров

2. Ошибка компиляции C# (дублирующиеся атрибуты)

3. Неявная структура Sparse Fieldsets

4. Отсутствие примеров в Swagger

5. Неочевидное поведение идемпотентности

Общая оценка API

Удобство: 7/10

Понятность: 6/10

Устойчивость: 8/10

Итоговая оценка: 7/10

Предложения по улучшению API

1. Улучшение документации

2. Стандартизация формата ошибок (RFC 7807)

3. Добавление HATEOAS ссылок

4. Стандартные заголовки Rate Limiting

5. Bulk операции

6. Расширенная фильтрация и сортировка

7. Webhooks для уведомлений

8. OpenAPI 3.1 с полной спецификацией

Результаты