Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 10 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,14 +28,18 @@ Available on [Maven Central](https://search.maven.org/#search%7Cgav%7C1%7Cg%3A%2

# Docker

Available on [Docker Hub](https://hub.docker.com/r/quen2404/openapi-diff/)
Available on [Docker Hub](https://hub.docker.com/r/quen2404/openapi-diff/) as `quen2404/openapi-diff`.

## Build image
## Build the image

This is only required if you want to try new changes in the Dockerfile of this project.

```bash
docker build -t openapi-diff .
docker build -t local-openapi-diff .
```

You can replace the local image name `local-openapi-diff` by any name of your choice.

## Run an instance

In this example the `$(pwd)/src/test/resources` directory is mounted in the `/specs` directory of the container
Expand All @@ -44,9 +48,11 @@ in readonly mode (`ro`).
```bash
docker run -t \
-v $(pwd)/src/test/resources:/specs:ro \
openapi-diff /specs/path_1.yaml /specs/path_2.yaml
quen2404/openapi-diff /specs/path_1.yaml /specs/path_2.yaml
```

The remote name `quen2404/openapi-diff` can be replaced with `local-openapi-diff` or the name you gave to your local image.

# Usage
OpenDiff can read swagger api spec from json file or http.

Expand Down