RSS DEV-Gemeinschaft

Swagger UI + Docker: Ersteinrichtung

Die Umgebung besteht aus einem Mac mit einem Apple M1-Prozessor, auf dem das Betriebssystem Sonoma 14.6.1 läuft, und Docker Desktop in der Version 4.34.2. Die Verzeichnisstruktur hat drei Unterordner: top, docker und openapi. Der Unterordner docker enthält eine .env-Datei und eine docker-compose.yml-Datei, während der Unterordner openapi eine openapi.yml-Datei enthält. Die .env-Datei setzt die Umgebungsvariable SWAGGER_UI_HOST_PORT. Die docker-compose.yml-Datei definiert einen Dienst namens swagger-ui, der das offizielle swaggerapi/swagger-ui:v5.17.14-Image verwendet. Die Umgebungsvariable SWAGGER_JSON wird auf den absoluten Pfad der openapi.yml-Datei gesetzt, die als Volume innerhalb des Docker-Containers gemountet wird. Der Container exposeiert den Port 8080, und die openapi.yml-Datei definiert eine minimale API-Dokumentation, die der OAS 3.0.3 entspricht. Um den Container und das Image zu erstellen, muss der Benutzer docker compose create in der Terminal ausführen, dann den Container mit docker compose start starten. Schließlich kann der Benutzer Swagger UI öffnen, indem er http://localhost:{SWAGGER_UI_HOST_PORT} in seinem Browser öffnet.
favicon
dev.to
Swagger UI + Docker: Initial Setup