swagger-brake

The idea behind swagger-brake is to detect and prevent introducing any type of breaking API change within your application, so your APIs can remain backward-compatible at all times.

You can find the detailed documentation here.

The available releases can be found here

The master branch represents the ongoing development of the tool. For the release versions, you can check out the corresponding tags.

On top of the CLI interface, there are Maven and Gradle plugins also available for easier integration into any existing pipeline.

Maven plugin can be found here.

Gradle plugin can be found here.

Building

The application is using Gradle as a build system and building it can be done by executing the following command:

$ ./gradlew clean build shadowJar

License

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

   http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.