Swagger-Diff

A docker image for Swagger::Diff, by Civis Analytics.

• Dockerfile source
• swagger-diff CLI reference
• Using Swagger to detect breaking API changes

Installation

Pull the jamesmessinger/swagger-diff image from DockerHub

docker pull jamesmessinger/swagger-diff

Usage

You can run this Docker image just like the swagger-diff CLI:

docker run jamesmessinger/swagger-diff \
  http://api.com/v1/swagger.json \
  http://api.com/v2/swagger.json

NOTE: If you want to compare two local files, then mount a volume:

docker run \
  -v $(pwd):/api \
  jamesmessinger/swagger-diff \
  /api/v1.json \
  /api/v2.json

Building Locally

To build/test the image locally on your computer:

1. Clone this repo
   git clone https://github.com/JamesMessinger/docker-images.git

2. Build the image
   docker build --tag jamesmessinger/swagger-diff:latest swagger-diff

3. Run the image
   See the usage section above

4. Publish the image to DockerHub
   docker push jamesmessinger/swagger-diff:latest