Skip to content

Commit db52ba8

Browse files
committed
docs(docker): extend usage example
1 parent f0d0452 commit db52ba8

1 file changed

Lines changed: 14 additions & 4 deletions

File tree

docker/README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -37,10 +37,20 @@ same [openapi-cop CLI flags](https://github.com/EXXETA/openapi-cop#cli-usage):
3737

3838
### Example
3939

40-
The following command will run the proxy against a provided target server, taking as a reference a given OpenAPI
41-
document, and expose port 8888 to the host system.
42-
43-
```docker run --rm -p 8888:8888 --env TARGET=https://some-host-name:1234 --env FILE=some-openapi-document.json lxlu/openapi-cop```
40+
The following command will run the proxy against a provided target server, taking as a reference a given local
41+
openapi.json file and running in "silent" mode, and use the host's network.
42+
43+
```bash
44+
docker run -it --network="host" \
45+
-v "$(pwd)/local/openapi.json:/openapi.json" \
46+
--env "TARGET=http://my-target-server:1234/baseApi/v1" \
47+
--env "FILE=/openapi.json" \
48+
--env "SILENT=1" \
49+
lxlu/openapi-cop
50+
```
51+
52+
Then `curl http://0.0.0.0:8888/some-target-endpoint` will respond the same
53+
as `curl http://my-target-server:1234/baseApi/v1/some-target-endpoint` but with additional openapi-cop headers.
4454

4555
## License
4656

0 commit comments

Comments
 (0)