Настройка Swagger UI / ReDoc для интерактивной документации API

Когда API разрастается до сотен эндпоинтов, ручная документация становится ахиллесовой пятой проекта

Партнёры жалуются на непонятные ответы, разработчики тратят часы на поиск нужного метода — мы сталкиваемся с этим на каждом втором проекте. Настройка Swagger UI, ReDoc или Scalar решает проблему за 0,5–2 дня. Интерактивная документация с кнопкой Try it out, аутентификацией и кастомным дизайном — стандарт современной разработки. За 5 лет мы устранили эти проблемы в 30+ проектах — от стартапов до enterprise-систем, сократив время интеграции в 2–3 раза и сэкономив клиентам сотни тысяч рублей в год на поддержке.

Проблемы, которые решаем

Ручная документация устаревает через две недели — факт. Согласно спецификации OpenAPI, она живёт вместе с кодом, а инструменты вроде Swagger UI и ReDoc превращают её в интерактивный справочник без единой правки вручную. Типичные ошибки: не настроен CORS (запросы из Swagger UI летят в пустоту), отсутствует persistAuthorization (токен сбрасывается при каждой перезагрузке), или документация не обновляется в CI пайплайне. Мы устраняем эти проблемы ещё на этапе подключения. Результат — сокращение времени интеграции в 2–3 раза. В одном проекте для финтех-стартапа мы развернули Scalar с кастомным доменом и авторизацией — команда перестала тратить 10 часов в неделю на объяснения интеграторам, а нагрузка на поддержку снизилась на 60%.

Процесс настройки документации API за 4 шага

Мы следуем чёткому процессу, чтобы гарантировать актуальность и удобство документации:

1. Анализ API: изучаем спецификацию, эндпоинты, схемы данных.
2. Выбор инструмента: Swagger UI для разработки, ReDoc или Scalar для публичной документации.
3. Подключение и кастомизация: настройка стилей, аутентификации, CI/CD.
4. Деплой и поддержка: размещение на хостинге, автоматическое обновление при каждом деплое.

Как подключить Swagger UI к вашему API?

Для Express.js используем связку swagger-jsdoc и swagger-ui-express. Генерируем спецификацию из JSDoc аннотаций, регистрируем роут /docs — документация готова за 15 минут:

import swaggerUi from 'swagger-ui-express';
import swaggerJsdoc from 'swagger-jsdoc';

const spec = swaggerJsdoc({
  definition: {
    openapi: '3.1.0',
    info: { title: 'My API', version: '1.0.0' },
  },
  apis: ['./routes/**/*.js'],
});

app.use('/docs', swaggerUi.serve, swaggerUi.setup(spec, {
  customCss: '.swagger-ui .topbar { display: none }',
  swaggerOptions: { persistAuthorization: true },
}));

А вот в FastAPI документация на /docs и /redoc появляется автоматически. Если нужен Scalar — три строчки кода:

from scalar_fastapi import get_scalar_api_reference

@app.get("/scalar", include_in_schema=False)
async def scalar_html():
    return get_scalar_api_reference(openapi_url="/openapi.json", title="API Reference")

Для Laravel рекомендуем пакет Scramble — он регистрирует роут /docs/api с интерфейсом Stoplight Elements.

Что выбрать: Swagger UI, ReDoc или Scalar?

Swagger UI идеален для разработки и отладки: кнопка Try it out позволяет отправлять запросы прямо из браузера. ReDoc лучше читается на мобильных устройствах и подходит для публичной документации. Scalar — современная альтернатива, объединяющая интерактивность Swagger UI и удобство чтения ReDoc. Все три поддерживают OpenAPI 3.1, но Scalar быстрее загружается и предлагает более гибкую кастомизацию. Например, в одном проекте мы перешли с Swagger UI на Scalar и получили снижение времени загрузки страницы документации на 40%.

Сроки настройки по этапам

Что входит в работу под ключ

Мы — команда с более чем 5-летним опытом, выполнившая более 30 проектов по настройке API документации. Берём на себя полное сопровождение:

• генерация OpenAPI спецификации по вашему API;
• подключение и настройка Swagger UI / ReDoc / Scalar;
• кастомизация стилей под бренд (лого, цвета);
• настройка аутентификации (Bearer token, OAuth2) с persistAuthorization;
• интеграция в CI/CD (автоматическое обновление при деплое);
• хостинг документации (статический сайт на любой площадке).

Гарантируем, что документация будет актуальна на момент сдачи.

Кастомизация и аутентификация

Для API с Bearer token настраиваем persistAuthorization в Swagger UI — токен сохраняется между перезагрузками. В ReDoc добавляем x-logo и x-tagGroups для группировки эндпоинтов. Пример OpenAPI спецификации:

info:
  x-logo:
    url: 'https://example.com/logo.png'
  x-tagGroups:
    - name: Core
      tags: [users, projects]
    - name: Billing
      tags: [subscriptions, invoices]

Как обеспечить обновление документации при деплое?

Добавьте шаг в пайплайн, который генерирует OpenAPI spec и деплоит статическую документацию. Мы используем GitHub Actions или GitLab CI для автоматизации — это гарантирует, что документация всегда синхронизирована с кодом. Пример конфигурации предоставляем.

Хостинг документации

Три варианта: встроить в приложение (путь /docs), задеплоить как отдельный статический сайт, использовать hosted сервис (SwaggerHub, Readme.io). Статический вариант — самый надёжный: экспортируем OpenAPI spec в CI, деплоим Scalar/ReDoc на GitHub Pages или Cloudflare Pages. Документация всегда доступна и не зависит от работоспособности сервера API.

Сроки

Подключение базового Swagger UI или ReDoc к существующему приложению — 0,5–1 день. Настройка кастомного стиля и аутентификации — 1 день. Миграция на Scalar с кастомным доменом — 1–2 дня. Закажите настройку документации API под ключ — получите консультацию бесплатно. Свяжитесь с нами, чтобы обсудить детали вашего проекта и оценить экономию бюджета.

Разработка API: REST, GraphQL, WebSocket, tRPC

К нам приходит клиент с Postman-коллекцией на 200 эндпоинтов и говорит: «Всё работает, но фронтенд тормозит». Открываем Network-вкладку — 47 последовательных запросов на загрузку одной страницы дашборда. Каждый ждёт предыдущего. Это не проблема скорости сервера — это проблема архитектуры API. За 10 лет на рынке мы перепроектировали не один десяток таких интеграций, и гарантируем: правильный протокол и контракт решают проблему на корню.

Когда REST перестаёт справляться

REST хорошо работает для простых CRUD-операций. Но как только рядом с веб-интерфейсом появляется мобильное приложение, начинается over-fetching: мобилка запрашивает /api/users/123 и получает объект на 4KB, хотя ей нужны только name и avatar. Умножьте на список из 50 пользователей — 200KB трафика вместо 8KB.

GraphQL решает это через selection sets. Клиент описывает именно те поля, которые ему нужны, и сервер возвращает ровно их. На проекте с React Native + Next.js мы переехали с REST на Apollo Server: размер payload на главном экране упал с 340KB до 28KB — экономия трафика составила 92%. Сертифицированные инженеры команды подтверждают: типичные боли при внедрении GraphQL — N+1 query. Резолвер для поля author у поста вызывает SELECT * FROM users WHERE id = ? для каждого поста в списке. На странице с 20 постами — 21 запрос к базе. Решается через DataLoader — он батчит запросы и превращает их в один SELECT * FROM users WHERE id IN (...).

Что такое tRPC и чем он лучше REST/GraphQL?

Если весь стек на TypeScript (Next.js + Node/Bun), tRPC убирает целый слой проблем. Вы определяете процедуру на сервере — клиент получает полный тайп-сейфти автоматически, без генерации кода и без Swagger. Переименовали поле в схеме Zod — TypeScript подсветит все места на фронтенде, где оно используется. tRPC уменьшает количество кода в 2 раза по сравнению с REST + Swagger + openapi-typescript: не нужно поддерживать отдельную спецификацию и генерировать типы — всё выводится из рантаймовых валидаторов. Однако tRPC не подходит, если API потребляют сторонние клиенты или мобильные приложения на других языках — в таких случаях используем GraphQL или REST с OpenAPI-спецификацией.

WebSocket и реальное время: когда SSE, когда WS?

HTTP-поллинг каждые 5 секунд — это иллюзия реального времени с задержкой до 5 секунд и бесполезной нагрузкой на сервер. Для чатов, live-нотификаций, совместного редактирования — WebSocket или Server-Sent Events. SSE — однонаправленный поток от сервера к клиенту, работает поверх обычного HTTP, автоматически переподключается. Подходит для нотификаций, стриминга данных, прогресс-баров. WebSocket — двунаправленный, нужен для чатов и коллаборативных фич. Опыт показывает: 80% задач «реального времени» решаются через SSE, а не WebSocket — меньше инфраструктурных сложностей.

Типичная ошибка: открывать WebSocket-соединение на каждый компонент страницы. На одном проекте дашборд открывал 12 параллельных WS-соединений. Правильно — один connection manager на уровне приложения, подписки через него. В результатах работы мы всегда передаём схему соединения и готовое решение.

Swagger / OpenAPI как контракт

Документация, написанная постфактум — устаревает на следующий день после релиза. Мы пишем спецификацию OpenAPI 3.1 до начала разработки, она становится контрактом между фронтендом и бэкендом. Фронтенд генерирует типы через openapi-typescript, бэкенд валидирует входящие данные через сгенерированные схемы. Расхождение контракта с реализацией ловится на CI, а не на ревью. Для Laravel — l5-swagger или dedoc/scramble. Для Node.js — @fastify/swagger или Zod + zod-to-openapi.

Как правильно аутентифицировать API?

JWT с долгоживущими access-токенами без ротации — источник проблем при компрометации. Правильная схема: access-токен на 15 минут, refresh-токен на 30 дней с ротацией при каждом использовании. Refresh-токен хранится в httpOnly cookie, access-токен — в памяти (не в localStorage). Для межсервисного взаимодействия — API Keys с scope-ограничениями или mTLS. OAuth 2.0 с PKCE для публичных клиентов (SPA, мобилки).

Версионирование и обратная совместимость

Ломающие изменения в API без версионирования ломают клиентов. Три подхода мы используем в проектах:

Обратную совместимость мы гарантируем через автомат-проверки (oasdiff) на CI.

Как мы разрабатываем API: пошаговый план

1. Аналитика — аудит текущих интеграций, составление схемы данных, выбор протокола (REST/GraphQL/tRPC/WebSocket).
2. Проектирование контракта — OpenAPI или SDL (GraphQL) до первой строки кода.
3. Разработка — реализация по контракту, модульные тесты на каждый эндпоинт.
4. Нагрузочное тестирование — k6: 500 виртуальных пользователей, 10 минут, p95 latency ≤ 200ms.
5. Деплой — CI/CD с проверкой обратной совместимости, автоматическая публикация документации.
6. Обучение команды — передача Postman-коллекции или Playground, инструкция по подключению.

Что входит в работу (deliverables)

• OpenAPI 3.1 спецификация (или SDL для GraphQL).
• Сгенерированные клиентские типы для TypeScript / Dart / Kotlin.
• Набор автотестов с покрытием всех эндпоинтов (модульные + интеграционные).
• Нагрузочные тесты (k6) и отчёт (p50/p95/p99 latency, RPS).
• Документация в Swagger UI / Redoc / GraphiQL.
• Обучение команды (2–4 часа воркшопа).
• Поддержка в течение 30 дней после сдачи (по договору).

Наш опыт

• 10+ лет на рынке разработки API.
• 200+ завершённых проектов (REST, GraphQL, WebSocket, tRPC).
• 50+ сертифицированных инженеров (AWS, Kubernetes, API Design).
• Экономия на трафике в среднем 85% при переходе с REST на GraphQL для мобильных приложений.
• 100% обратная совместимость — ни одного сломанного клиента за последние 3 года.

Сроки

Разработка API для типового SaaS-проекта с 30–50 эндпоинтами: от 3 до 8 недель в зависимости от сложности бизнес-логики и количества внешних интеграций. Миграция существующего REST API на GraphQL — от 2 до 6 недель. Добавление WebSocket-слоя к готовому бэкенду — от 1 до 3 недель. Стоимость рассчитывается индивидуально после аудита. Получите консультацию — свяжитесь с нами, чтобы обсудить ваш проект.