diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 57173cc2..d21c577a 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -125,6 +125,12 @@ Depending on the kind of contribution, maybe not all kinds of tests are needed, * Run `./indocker composer infect:test` to run both unit and database tests (over sqlite) and then apply mutations to them with [infection](https://infection.github.io/). * Run `./indocker composer ci` to run all previous commands together, parallelizing non-conflicting tasks as much as possible. +## Testing endpoints + +The project provides a Swagger UI container for dev envs, which can be accessed in http://localhost:8005. + +It will automatically load the contents of `docs/swagger`, so you can make any updates and they will get reflected. + ## Pull request process **Important!**: Before starting to work on a pull request, make sure you always [open an issue](https://github.com/shlinkio/shlink/issues/new/choose) first. diff --git a/docker-compose.yml b/docker-compose.yml index ca0064b4..b83b5f6b 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -3,7 +3,7 @@ version: '3' services: shlink_nginx: container_name: shlink_nginx - image: nginx:1.19.6-alpine + image: nginx:1.25-alpine ports: - "8000:80" volumes: @@ -40,7 +40,7 @@ services: shlink_swoole_proxy: container_name: shlink_swoole_proxy - image: nginx:1.19.6-alpine + image: nginx:1.25-alpine ports: - "8002:80" volumes: @@ -164,7 +164,7 @@ services: shlink_mercure_proxy: container_name: shlink_mercure_proxy - image: nginx:1.19.6-alpine + image: nginx:1.25-alpine ports: - "8001:80" volumes: @@ -175,7 +175,7 @@ services: shlink_mercure: container_name: shlink_mercure - image: dunglas/mercure:v0.14 + image: dunglas/mercure:v0.15 ports: - "3080:80" environment: @@ -186,10 +186,18 @@ services: shlink_rabbitmq: container_name: shlink_rabbitmq - image: rabbitmq:3.9-management-alpine + image: rabbitmq:3.11-management-alpine ports: - "15672:15672" - "5672:5672" environment: RABBITMQ_DEFAULT_USER: "rabbit" RABBITMQ_DEFAULT_PASS: "rabbit" + + shlink_swagger_ui: + container_name: shlink_swagger_ui + image: swaggerapi/swagger-ui:v5.7.1 + ports: + - "8005:8080" + volumes: + - ./docs/swagger:/app