clipmyhorse/openapi-bc-checker

OpenAPI Backward Compatibility Checker

dev-main 2025-12-09 16:04 UTC

Requires

• php: ^8.1
• cebe/php-openapi: ^1.0
• symfony/console: ^6.0|^7.0
• symfony/process: ^6.0|^7.0
• symfony/yaml: ^6.0|^7.0

Requires (Dev)

• humbug/box: ^4.6
• phpstan/phpstan: ^1.10
• phpunit/phpunit: ^10.0
• squizlabs/php_codesniffer: ^3.7

MIT

README

A command-line tool for detecting backward compatibility (BC) breaking changes in OpenAPI specifications.

Features

• Compare two OpenAPI specification files (JSON or YAML)
• Compare OpenAPI specs between two git commits
• Detect various types of BC breaks:
  • Removed endpoints
  • Removed operations (HTTP methods)
  • Removed or changed required parameters
  • Removed or changed responses
  • Schema changes (property type changes, new required properties)
  • Request body changes
• Detect minor and patch changes (following Semver)

Installation

composer install

For more installation options including PHAR distribution, see the Installation Guide.

Quick Start

./bin/openapi-bc-checker old-spec.yaml new-spec.yaml

Documentation

• Usage Guide - File mode, Git mode, and exit codes
• Examples - Sample specifications for major, minor, and patch changes
• BC Break Detection - Complete list of detected changes and example output
• Development - Running tests, linters, and building the PHAR

License

This project is licensed under the MIT License.

Copyright (c) 2025 ClipMyHorse.TV Services & Development GmbH

See the LICENSE file for the full license text.