Детектор breaking changes API и план миграции

Сравнивает две OpenAPI 3.x схемы, находит ломающие изменения и предлагает стратегии миграции

Подходит API-командам для оценки удаления полей, ужесточения типов и новых обязательных полей.

Примеры результатов

1 Примеры

Выявить breaking changes между версиями API

Сравнивает две OpenAPI-схемы и показывает изменения, ломающие текущих клиентов

Breaking changes are grouped by impact with migration strategies.
Показать параметры ввода
{ "oldSchema": "openapi: 3.0.3\npaths:\n /users:\n post:\n requestBody:\n required: false\n content:\n application/json:\n schema:\n type: object\n properties:\n name: { type: string }\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n properties:\n id: { type: string }\n name: { type: string }\n", "newSchema": "openapi: 3.0.3\npaths:\n /users:\n post:\n requestBody:\n required: true\n content:\n application/json:\n schema:\n type: object\n required: [name, role]\n properties:\n name: { type: string }\n role: { type: string }\n responses:\n \"200\":\n description: ok\n content:\n application/json:\n schema:\n type: object\n properties:\n id: { type: string }\n" }

Ключевые факты

Категория
Разработка и Web
Типы входных данных
textarea
Тип результата
html
Покрытие примерами
4
API доступен
Yes

Обзор

Детектор breaking changes API — это инструмент для сравнения двух версий OpenAPI 3.x схем. Он автоматически находит ломающие изменения, такие как удаленные поля, новые обязательные параметры или ужесточение типов данных, и формирует наглядный HTML-отчет со стратегиями безопасной миграции для ваших клиентов.

Когда использовать

  • •Перед релизом новой мажорной или минорной версии API для проверки обратной совместимости.
  • •При рефакторинге контрактов данных, чтобы убедиться, что изменения не сломают текущие интеграции.
  • •Для подготовки документации по миграции (changelog) для внешних разработчиков и партнеров.

Как это работает

  • •Вставьте текущую спецификацию OpenAPI 3.x в поле «Старая OpenAPI схема».
  • •Добавьте обновленную версию контракта в поле «Новая OpenAPI схема».
  • •Инструмент проанализирует обе схемы и выявит различия в путях, методах, параметрах и структурах ответов.
  • •Получите подробный отчет с группировкой ломающих изменений по уровню влияния и рекомендациями по миграции.

Сценарии использования

Аудит изменений в API перед слиянием (merge) ветки в основной репозиторий.
Планирование версионирования API (например, переход от v1 к v2) с оценкой масштаба изменений.
Генерация инструкций по переходу на новую версию API для frontend-разработчиков или мобильных команд.

Примеры

1. Проверка добавления обязательных полей

Backend-разработчик
Контекст
Команда добавляет ролевую модель в API создания пользователя.
Проблема
Нужно убедиться, что новые требования к запросу не сломают старые клиенты, которые не передают роль при регистрации.
Как использовать
Вставить старую схему без поля role и новую схему, где role добавлен в массив required для POST-запроса /users.
Результат
Инструмент подсвечивает добавление обязательного поля role как критическое ломающее изменение и предлагает сделать его опциональным в текущей версии API.

2. Анализ удаления полей из ответа

API-архитектор
Контекст
В новой версии API решено убрать устаревшее поле name из ответа, заменив его на раздельные поля firstName и lastName.
Проблема
Оценить влияние удаления поля на потребителей API и подготовить план миграции.
Как использовать
Загрузить обе версии OpenAPI-схемы в соответствующие текстовые поля и запустить сравнение.
Результат
Генерируется HTML-отчет, указывающий на удаление поля name из схемы ответа 200 OK, с рекомендацией использовать стратегию deprecation (устаревания) перед полным удалением.

Проверить на примерах

development
Postman Collections - API Тестирование
Всесторонние примеры Postman collections включая API тестирование, скрипты автоматизации, переменные окружения, mock серверы и продвинутые паттерны тестирования для REST API
title token api
sample
Примеры OpenAI API
Комплексные примеры OpenAI API включая модели GPT, генерацию изображений DALL-E, обработку аудио Whisper и вызовы функций
title token api
sample
Графический API WebGPU
Современный графический API для высокопроизводительной 3D графики и GPU вычислений в браузере
title token api
sample
Примеры Truffle Development Suite
Примеры фреймворка разработки Ethereum Truffle включая смарт-контракты, тестирование, развертывание, миграции, отладку и рабочие процессы разработки
keywords migration,contract,testing
sample

FAQ

Какие форматы схем поддерживаются?

Инструмент поддерживает спецификации в формате OpenAPI 3.x. Вы можете вставить текст схемы в формате YAML или JSON.

Что считается ломающим изменением (breaking change)?

К ним относятся удаление существующих эндпоинтов, добавление новых обязательных параметров в запрос, удаление полей из ответа или изменение типов данных.

Показывает ли инструмент неломающие изменения?

Основной фокус сделан на выявлении именно ломающих изменений, которые могут нарушить работу текущих клиентов API, однако значимые структурные отличия также учитываются при анализе.

Безопасно ли вставлять сюда схемы моего API?

Да, инструмент обрабатывает текст схем на лету и не сохраняет ваши API-контракты на сервере.

В каком виде предоставляется результат?

Результат выводится в виде структурированного HTML-отчета, где изменения сгруппированы по уровню критичности с советами по исправлению и миграции.

Документация API

Конечная точка запроса

POST /ru/api/tools/api-breaking-changes-detector-migration-planner

Параметры запроса

Имя параметра Тип Обязательно Описание
oldSchema textarea Нет -
newSchema textarea Нет -

Формат ответа

{
  "result": "
Processed HTML content
",
  "error": "Error message (optional)",
  "message": "Notification message (optional)",
  "metadata": {
    "key": "value"
  }
}
HTML: HTML

Документация MCP

Добавьте этот инструмент к конфигурации сервера MCP: 

{
  "mcpServers": {
    "elysiatools-api-breaking-changes-detector-migration-planner": {
      "name": "api-breaking-changes-detector-migration-planner",
      "description": "Сравнивает две OpenAPI 3.x схемы, находит ломающие изменения и предлагает стратегии миграции",
      "baseUrl": "https://elysiatools.com/mcp/sse?toolId=api-breaking-changes-detector-migration-planner",
      "command": "",
      "args": [],
      "env": {},
      "isActive": true,
      "type": "sse"
    }
  }
}

Вы можете объединять несколько инструментов, например: `https://elysiatools.com/mcp/sse?toolId=png-to-webp,jpg-to-webp,gif-to-webp`, максимум 20 инструментов.

Если вы столкнулись с проблемами, пожалуйста, свяжитесь с нами по адресу [email protected]