1.6 Документация API: Swagger и OpenAPI
↑ Этап 1
Хорошая документация экономит дни. Нужно уметь читать её и, как аналитик, писать.
Для кого: общий (аналитик и PM).
Темы
Итого: 5 тем · ~24 мин · готово 0 из 5
| # | Тема | Приоритет | Чтение | Статус |
|---|---|---|---|---|
| 1 | Как читать документацию API | Обязательно | 4 мин | Не начато |
| 2 | OpenAPI и Swagger UI: структура спецификации | Обязательно | 6 мин | Не начато |
| 3 | Swagger Editor и описание метода | Обязательно | 5 мин | Не начато |
| 4 | Redoc, порталы документации, Confluence | Обязательно | 4 мин | Не начато |
| 5 | Версионирование и изменения контрактов | Обязательно | 5 мин | Не начато |
Практика
Прочитать публичный Swagger и описать метод по шаблону.
Чек-лист раздела
- Прочитал все темы
- Выполнил практику
- Могу объяснить каждую тему за 2 минуты вслух