🧪 Лаборатория Инструменты: 📖 OpenAPI · 🔧 Swagger · 💻 Python/FastAPI · 🐳 Docker
Лабораторная работа «REST + OpenAPI: проектирование и реализация API»¶
Зачем участникам эта лабораторная?¶
«Напишите нам API» — звучит как просьба, а превращается в хаос. REST без спецификации, эндпоинты, которые меняются после каждого релиза, документация, которой никто не верит.
А что если API можно спроектировать так, чтобы оно было понятно и бизнесу, и разработчикам, и тестировщикам?
В этой лабораторной вы научитесь проектировать REST API с использованием OpenAPI/Swagger и сразу реализовывать его на реальном языке программирования. Два модуля — от эволюции API до работающего кода.
За 4 часа вы научитесь:
- 📐 Анализировать бизнес-сценарии — выходить за рамки стандартного CRUD
- 📊 Проектировать ресурсы, методы и статусы — с учётом бизнес-логики
- 🖥 Создавать OpenAPI-спецификацию — в YAML-формате (Swagger/OpenAPI 3.0)
- 💻 Реализовывать контроллеры и обработчики — на Python/FastAPI
- 🔔 Писать тесты и генерировать документацию — из спецификации автоматически
- 🎯 Прототипировать и валидировать дизайн — на реальных кейсах
Что такое OpenAPI (вкратце)?¶
OpenAPI (ранее известный как Swagger) — стандарт описания REST API, который позволяет автоматически генерировать клиентский код, документацию и тесты.
Swagger — набор инструментов для работы с OpenAPI-спецификациями: редактор, UI для документации, генераторы кода.
Вместе они дают полную картину: проектирование → спецификация → код → документация → тесты.
Для кого¶
- Системные аналитики — научитесь переводить бизнес-требования в технические спецификации API
- Разработчики — освойте best practices проектирования и реализации API
- Архитекторы и тимлиды — принимайте решения по структуре API, версионированию и документации
- PM/PO — оценивайте сложность и сроки реализации API-интерфейсов
Не нужно: быть гуру программирования.
Нужно: базовое понимание REST API и HTTP-методов.
Практика за 4 часа¶
🚀 Модуль 1: Проектирование API (2 часа)¶
| Блок | Тема | Время |
|---|---|---|
| 1 | Анализ бизнес-сценариев и use cases системы управления задачами | 30 мин |
| 2 | Проектирование ресурсов, операций и отношений между ними | 30 мин |
| 3 | Создание OpenAPI-спецификации в YAML-формате | 45 мин |
| 4 | Прототипирование и валидация дизайна на реальных кейсах | 15 мин |
🏆 Модуль 2: Реализация API (2 часа)¶
| Блок | Тема | Время |
|---|---|---|
| 5 | Настройка окружения и поднятие локального сервера | 20 мин |
| 6 | Реализация контроллеров для спроектированных эндпоинтов | 45 мин |
| 7 | Добавление бизнес-логики: массовые операции, сложные фильтры, кастомные статусы | 30 мин |
| 8 | Тестирование и генерация документации из OpenAPI-спецификации | 25 мин |
Результат для бизнеса¶
Конкретика вместо общих слов:
| Было | Стало |
|---|---|
| «API меняется после каждого релиза» | «Спецификация утверждена, код генерируется из неё» |
| «Документация устарела через неделю» | «Документация всегда актуальна — она из спецификации» |
| «Бэкенд и фронтенд не синхронизированы» | «Клиентский код генерируется из той же спецификации» |
Общий язык с командой — споры заменяются спецификацией, предположения — документацией.
Скорость разработки — изменения в API сразу видны всем участникам процесса.
Что вы получите¶
Компетенции:
- ✓ Проектирование API на основе бизнес-сценариев — не-CRUD подход
- ✓ Создание OpenAPI-спецификаций — единый источник правды для API
- ✓ Реализация эндпоинтов на Python/FastAPI — от спецификации к коду
- ✓ Тестирование API — автоматическая генерация тестов из спецификации
- ✓ Документирование API — Swagger UI для команды и заказчиков
Материалы на руки:
- 📦 Готовый стенд — все компоненты в Docker, запускается одной командой
- 📖 OpenAPI-спецификация — шаблон для ваших проектов
- 💻 Код приложения — реализация на Python/FastAPI
- 📝 Шпаргалка — 20+ готовых правил проектирования API
- 🔧 Swagger UI — интерактивная документация вашего API
Чем эта лабораторная отличается¶
- 🎯 Два модуля в одной лабе — от проектирования до реализации
- 🔄 Spec-Driven подход — сначала спецификация, потом код
- 💼 Бизнес-контекст — каждый эндпоинт объясняется через пользовательские сценарии
- ⚡ Быстрый результат — за 4 часа получите работающее API с документацией
Ведущий¶
Валерий Зубаиров — системный аналитик с опытом в финтехе и высоконагруженных системах. Распиливал монолит кредитного скоринга, работал с платформами из 300+ сервисов. Магистр МГТУ им. Н. Э. Баумана, ментор Solvery, гость профильных подкастов.
Стоимость и подписка¶
| Цена | |
|---|---|
| 🔑 Подписка Boosty «Практик» (все лабораторные) | 950 ₽/мес |
| 🎫 Разовое участие | 1 500 ₽ |
📅 Ближайшая дата: 2026-06-27, 10:00-14:00 МСК · все мероприятия
Методические материалы¶
- Запись лабораторной работы
- Презентация и методические материалы
- Готовые скрипты и конфигурации
- Чек-листы и шаблоны
- Доступ к стенду на 7 дней
- Закрытый чат участников
- Ответы на вопросы в течение 14 дней
Дальнейший маршрут¶
- Docker для системных аналитиков — основы контейнеризации
- PostgreSQL Advanced — проектирование производительного слоя данных
- Kubernetes для системного аналитика — оркестрация и диагностика
💬 Обсуждение статьи
✈️ ✍️ Обсудить