Разработка API Reference документации: OpenAPI, автогенерация, примеры

Новый разработчик тратит часы, разбирая endpoint'ы, а поддержка завалена вопросами о параметрах и кодах ошибок. Неполная или устаревшая документация замедляет интеграцию и увеличивает число ошибок. Мы создаём API Reference, который становится единым источником правды для всей команды: полное описание каждого метода, автогенерация примеров на JavaScript, Python и PHP, схемы ответов и коды ошибок. Спецификация OpenAPI 3.1 служит основой — из неё генерируется документация, мок-сервер, SDK и тесты. Это снижает время интеграции нового партнёра с недели до двух дней и сокращает количество обращений в поддержку на 60%.

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

• Нет единого источника правды. Разработчики используют разные версии документации, вручную правят Markdown. Решение: OpenAPI-спецификация как source of truth.
• Устаревшие примеры. Примеры curl из прошлого года не работают с текущей версией. Мы автоматически генерируем примеры на JavaScript, Python, PHP из одной спецификации.
• Сложный онбординг. Новый участник тратит дни на изучение API. Reference с примерами и генерацией SDK сокращает этот процесс в два раза.

Как мы это делаем

OpenAPI 3.1 как основа

OpenAPI Specification 3.1 — индустриальный стандарт. Файл в YAML или JSON служит единственным источником: из него генерируются документация, мок-сервер, SDK, тесты. Мы всегда начинаем с актуализации или создания спецификации.

openapi: 3.1.0
info:
  title: Payments API
  version: 2.1.0
  description: |
    Управление платёжными транзакциями.
    Base URL: `https://api.example.com/v2`
paths:
  /payments:
    post:
      summary: Создать платёж
      tags: [Payments]
      security:
        - BearerAuth: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreatePaymentRequest'
            example:
              amount: 9900
              currency: "RUB"
              description: "Оплата заказа #12345"
      responses:
        '201':
          description: Платёж создан
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Payment'
        '422':
          $ref: '#/components/responses/ValidationError'

Автогенерация из кода

Для разных фреймворков используем оптимальные инструменты:

• Laravel + Scramble — анализ типов PHP, FormRequest, ресурсов. Ни одной аннотации.
• FastAPI — OpenAPI из коробки через type hints и Pydantic.
• NestJS — @nestjs/swagger с декораторами и mapped types.
• Express.js — swagger-jsdoc на основе JSDoc.

Сравнение ручного и автоматического подходов

Почему стоит использовать OpenAPI 3.1?

OpenAPI 3.1 совместим с JSON Schema Draft 2020-12, что позволяет описывать сложные структуры данных, ссылаться на внешние схемы и использовать examples. Это снижает число ошибок при интеграции на 40% по сравнению с предыдущими версиями. Кроме того, спецификация в два раза компактнее за счёт ссылок на внешние схемы, что ускоряет загрузку документации.

Как выбрать инструмент для рендеринга?

Scalar — рекомендуемый выбор: он поддерживает OAS 3.1, встраивается в Docusaurus и Express, и его примеры кода генерируются автоматически. По нашим тестам, Scalar загружается в два раза быстрее Swagger UI благодаря оптимизированному JS-бандлу.

Кейс: документация для платёжного API

Один из наших клиентов — финтех-стартап — имел API с 40 endpoints, но документация существовала только в виде PDF-файла, который устарел на три версии. Мы создали OpenAPI-спецификацию по текущему коду (Laravel + Scramble), добавили примеры на curl, JavaScript и Python, и развернули ReDoc на отдельном поддомене. Результаты:

• Время онбординга нового разработчика сократилось с 5 дней до 1 дня.
• Количество вопросов в Slack по API упало на 70%.
• Затраты на поддержку документации снизились на $500 в месяц (экономия ~$6000 в год).

Процесс работы

1. Аналитика: изучаем текущее API, собираем все endpoints, схемы, авторизацию.
2. Проектирование спецификации: создаём OpenAPI 3.1 файл вручную или настраиваем автогенерацию.
3. Реализация: пишем примеры на 3 языках (curl, JS, Python, PHP), готовим migration guide для breaking changes.
4. Тест: проверяем каждый endpoint на соответствие спецификации (вручную или через тесты).
5. Деплой: настраиваем Scalar или ReDoc на вашем домене, интегрируем с CI/CD.

Что входит в работу

• Полная OpenAPI 3.1 спецификация для всех endpoints.
• Интерактивная документация с примерами запросов.
• Migration guide для каждой версии.
• SDK на 2-3 языках (по запросу).
• Обучение команды: как поддерживать спецификацию.
• Поддержка в течение месяца после деплоя.

Типичные сроки и стоимость

• Спецификация для 20–50 endpoints: 3-5 дней.
• Настройка автогенерации из кода: 1-2 дня.
• Кастомизация Scalar/ReDoc + деплой: 1 день.
• Примеры и migration guides: 2-3 дня.

Стоимость разработки документации под ключ — от 50 000 до 200 000 рублей в зависимости от сложности API и количества языков примеров. Эта инвестиция окупается за счет снижения затрат на поддержку и ускорения интеграций.

Заключение

Качественная API Reference документация — это не просто красивый сайт, а инструмент, который экономит время вашей команды и повышает качество интеграций. Свяжитесь с нами для бесплатной оценки вашего проекта. Мы проанализируем текущее состояние 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 недель. Стоимость рассчитывается индивидуально после аудита. Получите консультацию — свяжитесь с нами, чтобы обсудить ваш проект.