From 5d90094f83435df113d82d9e631b28bcd7d72feb Mon Sep 17 00:00:00 2001 From: victorlpgazolli Date: Tue, 21 Mar 2023 20:39:48 -0300 Subject: [PATCH] add dockerfile --- Dockerfile | 19 +++++++++++++++++++ README.md | 8 ++++++++ 2 files changed, 27 insertions(+) create mode 100644 Dockerfile diff --git a/Dockerfile b/Dockerfile new file mode 100644 index 0000000..6c404e0 --- /dev/null +++ b/Dockerfile @@ -0,0 +1,19 @@ +FROM python:3.10 + +WORKDIR /app + +RUN apt update -qq && \ + python -m pip install --upgrade pip && \ + pip install poetry + + +COPY ["pyproject.toml", "./"] + +RUN poetry install + +COPY . . + +RUN pip install . + +CMD [ "mitmproxy2swagger" ] + diff --git a/README.md b/README.md index 55f9c8e..1398b73 100644 --- a/README.md +++ b/README.md @@ -26,6 +26,10 @@ First you will need python3 and pip3. $ pip install mitmproxy2swagger # ... or ... $ pip3 install mitmproxy2swagger +# ... or ... +$ git clone git@github.com:alufers/mitmproxy2swagger.git +$ cd mitmproxy2swagger +$ docker build -t mitmproxy2swagger . ``` Then clone the repo and run `mitmproxy2swagger` as per examples below. @@ -58,6 +62,8 @@ To create a specification by inspecting HTTP traffic you will need to: ```bash $ mitmproxy2swagger -i -o -p + # ... or ... + $ docker run -it -v $PWD:/app mitmproxy2swagger mitmproxy2swagger -i -o -p ``` Please note that you can use an existing schema, in which case the existing schema will be extended with the new data. You can also run it a few times with different flow captures, the captured data will be safely merged. @@ -94,6 +100,8 @@ To create a specification by inspecting HTTP traffic you will need to: ```bash $ mitmproxy2swagger -i -o -p [--examples] + # ... or ... + $ docker run -it -v $PWD:/app mitmproxy2swagger mitmproxy2swagger -i -o -p [--examples] ``` Run the command a second time (with the same schema file). It will pick up the edited lines and generate endpoint descriptions.