Документация API Журнала IT Top Academy

У IT Top Academy нет публичной документации API. Этот проект заполняет пробел — покрывает 34 эндпоинта в 11 функциональных группах.

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

1. Откройте Swagger UI — Swagger UI работает сразу, без токена: воркер отдаёт анонимизированные mock-данные
2. Попробуйте логин — нажмите «Try it out» на /auth/login. Воркер (Cloudflare-прокси) пересылает запрос на реальный API и возвращает живой JWT
3. Получите токен — если нужен доступ к реальным данным, см. Аутентификация
4. Читайте документацию — выберите раздел API для детального справочника эндпоинтов с описанием полей

Что делает проект

• Собирает реальные ответы API через авторизованные запросы
• Валидирует структуру через Pydantic — при изменении API пайплайн падает и открывает Issue в GitHub
• Анонимизирует данные через Faker — никаких реальных имён, ID и дат в публичном репозитории
• Генерирует openapi.json и публикует Swagger UI + текстовую документацию

Пайплайн CI

Последовательность шагов при каждом запуске (крон ночью или вручную):

tests → collect → validate → anonymize → publish → worker
                                          ↘ mkdocs

1. tests — юнит-тесты проекта
2. collect — запросы к реальному API, сбор ответов
3. validate — валидация схем Pydantic; при ошибке — Issue в GitHub
4. anonymize — подмена чувствительных данных через Faker
5. publish — генерация openapi.json и деплой Swagger UI на GitHub Pages
6. worker — сборка и деплой Cloudflare Worker (mock-сервер + прокси)
7. mkdocs — сборка и деплой текстовой документации на GitHub Pages

Навигация

Страница	Содержание
Аутентификация	Получение токена, заголовки, кнопка Authorize
Swagger UI	Интерактивный проводник по API
Mock-сервер	Как работает Cloudflare Worker
Глоссарий	Термины и понятия, используемые в документации
Справочник API	Детальная документация эндпоинтов по группам