Welcome to swagger-compare’s documentation!

swagger-compare aims to make the job of communicating api changes easier. The current phase of this project deals only with endpoints that have been marked as deprecated. By making use of the x-replaced-by and x-remove-on swagger extensions a clear, and automated diff summary can be generated from the baseline swagger, and the new swagger document.

give it a try!

docker run kjjuno/swagger-compare https://raw.githubusercontent.com/kjjuno/swagger-compare/master/test/petstore.yaml https://raw.githubusercontent.com/kjjuno/swagger-compare/master/test/petstore-new.yaml