diff --git a/README.md b/README.md index 2e0fb50..96e7be0 100644 --- a/README.md +++ b/README.md @@ -44,3 +44,18 @@ Please note the following guidelines: - OpenAPI Generator can't generate Python client with Java 17+ - https://github.com/OpenAPITools/openapi-generator/issues/13684 + +## Usage + +You can launch the Swagger UI to browse the OpenAPI specs locally using Docker. +First, make sure you have `docker-compose.yml` in this directory. Then run: + +```sh +docker-compose up +``` + +By default, the Swagger UI will be available at: [http://localhost:8080](http://localhost:8080) + +### Using Docker Command + +Alternatively, you can use the following Docker command: diff --git a/docker-compose.yml b/docker-compose.yml new file mode 100644 index 0000000..1d24bb3 --- /dev/null +++ b/docker-compose.yml @@ -0,0 +1,12 @@ +version: '3.8' +services: + swagger-ui: + image: swaggerapi/swagger-ui:latest + container_name: line-open-api-doc + ports: + - "8080:8080" + environment: + - PORT=8080 + - API_URL=/openapi/messaging-api.yml + volumes: + - ./:/usr/share/nginx/html/openapi \ No newline at end of file