REST + OpenAPI: проектирование и реализация API

За 4 часа вы:

• Проанализируете бизнес-сценарии и выйдете за рамки стандартного CRUD

• Спроектируете ресурсы, методы и статусы с учётом бизнес-логики

• Создадите OpenAPI-спецификацию в YAML-формате (Swagger/OpenAPI 3.0)

• Реализуете контроллеры и обработчики на Python/FastAPI

• Напишете тесты и сгенерируете документацию из спецификации

✅ Что такое API-дизайн (вкратце)?

API (Application Programming Interface) — это набор правил и протоколов, которые позволяют разным программам общаться друг с другом. Хороший API-дизайн — это не просто создание CRUD-операций, а проектирование интерфейсов, которые отражают бизнес-домен, легко понимаются разработчиками и могут эволюционировать без ломающих изменений.

OpenAPI (ранее Swagger) — это стандарт описания REST API, который позволяет формализовать спецификацию в машиночитаемом формате и автоматически генерировать документацию, клиентский код и тесты. Это must-have навык для системных аналитиков и разработчиков, работающих с API.

✅ Для кого

Системные аналитики, разработчики, архитекторы, тимлиды, PM/PO, все, кто:

• Хочет научиться переводить бизнес-требования в технические спецификации API

• Стремится освоить best practices проектирования и реализации API

• Принимает решения по структуре API, версионированию и документации

Не нужно: быть гуру программирования.

Нужно: базовое понимание REST API и HTTP-методов. Для модуля реализации — опыт работы с любым языком программирования.

✅ Программа мероприятия

Модуль 1: Проектирование API (2 часа)

Анализ бизнес-сценариев и use cases системы управления задачами. Выходим за рамки стандартного CRUD.

Модуль 2: Реализация API (2 часа)

Настройка окружения, реализация контроллеров, добавление бизнес-логики, тестирование и генерация документации.

Ключевой блок! Создание OpenAPI-спецификации и реализация эндпоинтов на Python/FastAPI

• Проектирование ресурсов и операций с учётом бизнес-логики

• Формализация дизайна в YAML (Swagger/OpenAPI 3.0)

• Реализация контроллеров и обработчиков

• Автоматические тесты и генерация документации

✅ Вы уйдёте с результатами

Компетенции, которые вы прокачаете:

✓ Проектирование API, отражающих бизнес-домен

✓ Создание OpenAPI-спецификаций для коммуникации между командами

✓ Реализация REST API на Python/FastAPI

✓ Тестирование и документирование API

✓ Оценка качества API-дизайна

Что получите «на руки»:

✓ OpenAPI-спецификацию для системы управления задачами

✓ Рабочий прототип API с реализованными эндпоинтами

✓ Набор тестов для валидации API

✓ Чек-лист для оценки качества API-дизайна

✓ Доступ к стенду на 7 дней для самостоятельной практики

✅ Чем эта лабораторная отличается

✓ Модульный подход: можно пройти только проектирование, только реализацию, или оба модуля вместе

✓ Фокус на не-CRUD API: учимся проектировать API для сложных бизнес-процессов

✓ Промышленный кейс: работаем с реальными сценариями из системы управления задачами

✓ Интеграция проектирования и реализации: полный цикл от требований до работающего кода

✅ Предпосылки и формат

Требования к участникам:

• Базовое понимание REST API и HTTP-методов

• Опыт работы с любым языком программирования (для модуля реализации)

• Для модуля проектирования: понимание основ системного анализа или опыт работы с требованиями

Формат проведения:

• Онлайн, длительность 4 часа (2+2 часа с перерывом)

• Среда преднастроена: Docker Compose с предустановленными инструментами

• Модульный формат: можно участвовать только в одном модуле

✅ Дальнейший маршрут развития

После этой лабораторной рекомендуем:

• Продвинутый API-дизайн: версионирование, безопасность, оптимизация производительности

• Event-driven архитектура: переход от REST к асинхронным коммуникациям через message brokers

• Микросервисная архитектура: проектирование API для распределенных систем

• Другие лабораторные сообщества: Docker, Kubernetes, PostgreSQL, Prometheus, Kafka

Даты проведения:

• Ближайшая дата: 27 июня 10:00 - 14:00 МСК

Что получают участники:

• [x] Запись лабораторной работы

• [x] Презентация и методические материалы

• [x] Готовые скрипты и конфигурации

• [x] Чек-листы и шаблоны для проектирования API

• [x] Доступ к стенду на 7 дней для самостоятельной практики

Поддержка после мероприятия:

• [x] Закрытый чат для участников

• [x] Ответы на вопросы в течение 2 недель

• [x] Дополнительные материалы по теме API-дизайна

Ведущий: Валерий Зубаиров

• Экспертиза: Системный аналитик, финтех, высоконагруженные системы

• Распилил монолит кредитного скоринга, реализовал модуль каскадных моделей ML

• Участвовал в разработке продуктов с нуля, объединении платформ из 300+ сервисов

• Магистр МГТУ им. Н. Э. Баумана, ментор Solvery