https://github.com/docktape/swagger-brake

Swagger contract checker for breaking API changes
https://github.com/docktape/swagger-brake

api java rest rest-api restful restful-api swagger swagger-api swagger-parser

Last synced: 18 days ago
JSON representation

Swagger contract checker for breaking API changes

• Host: GitHub
• URL: https://github.com/docktape/swagger-brake
• Owner: docktape
• License: apache-2.0
• Created: 2018-10-31T20:23:28.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2026-01-13T15:40:09.000Z (18 days ago)
• Last Synced: 2026-01-13T18:19:30.333Z (18 days ago)
• Topics: api, java, rest, rest-api, restful, restful-api, swagger, swagger-api, swagger-parser
• Language: Java
• Homepage:
• Size: 3.02 MB
• Stars: 64
• Watchers: 2
• Forks: 15
• Open Issues: 5
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# 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](https://docktape.github.io/swagger-brake/).

The available releases can be found [here](https://github.com/docktape/swagger-brake/releases)

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](https://github.com/docktape/swagger-brake-maven-plugin).

Gradle plugin can be found [here](https://github.com/docktape/swagger-brake-gradle).

## Building

The application is using Gradle as a build system and building it can be done 

by executing the following command:

```bash

$ ./gradlew clean build shadowJar

```

## Sponsoring the project

If you want to help the project to develop faster and bring in new features and bugfixes you can buy me a coffee. Donations are never a necessity but very much appreciated.

Either use my Buy me a coffee link:

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://buymeacoffee.com/arnoldgalovics)

Or you can do it directly with PayPal:

[![](https://www.paypalobjects.com/en_US/i/btn/btn_donateCC_LG.gif)](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=X6XHVCPMRQEL4)

## License

```text

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.

```

## Publishing

### Snapshot

`./gradlew clean publish jreleaserDeploy`

### Release

`./gradlew clean publish jreleaserFullRelease`