Сообщество RSS DEV

Пользовательский интерфейс Swagger + Docker: первоначальная настройка

Среда состоит из Mac с CPU Apple M1, работающим под управлением системы Sonoma 14.6.1 и Docker Desktop версии 4.34.2. Структура каталогов включает три подкаталога: top, docker и openapi. Подкаталог docker содержит файл .env и файл docker-compose.yml, а подкаталог openapi - файл openapi.yml. Файл .env устанавливает переменную окружения SWAGGER_UI_HOST_PORT. Файл docker-compose.yml определяет сервис под названием swagger-ui, который использует официальный образ swaggerapi/swagger-ui:v5.17.14. Переменная окружения SWAGGER_JSON задается как абсолютный путь к файлу openapi.yml, который монтируется как том внутри контейнера Docker. Контейнер открывает порт 8080, а файл openapi.yml определяет минимальную документацию API, соответствующую OAS 3.0.3. Чтобы создать контейнер и образ, пользователю необходимо выполнить команду docker compose create в терминале, а затем запустить контейнер с помощью docker compose start. Наконец, пользователь может открыть Swagger UI, перейдя по адресу http://localhost:{SWAGGER_UI_HOST_PORT} в браузере.
favicon
dev.to
Swagger UI + Docker: Initial Setup