{"id":80082,"date":"2024-10-14T06:45:39","date_gmt":"2024-10-14T03:15:39","guid":{"rendered":"https:\/\/nabfollower.com\/blog\/swagger-ui-docker-initial-setup-11np\/"},"modified":"2024-10-14T06:45:39","modified_gmt":"2024-10-14T03:15:39","slug":"swagger-ui-docker-initial-setup-11np","status":"publish","type":"post","link":"https:\/\/nabfollower.com\/blog\/swagger-ui-docker-initial-setup-11np\/","title":{"rendered":"Swagger UI + Docker: Initial Setup"},"content":{"rendered":"

Summarize this content to 400 words in Persian Lang <\/p>\n

\u0645\u062d\u06cc\u0637 \u0632\u06cc\u0633\u062a<\/p>\n

\u0645\u06a9<\/p>\n

CPU: Apple M1
\n\u0633\u06cc\u0633\u062a\u0645 \u0639\u0627\u0645\u0644: Sonoma 14.6.1<\/p>\n

Docker Desktop<\/p>\n

\u0633\u0627\u062e\u062a\u0627\u0631 \u062f\u06cc\u0631<\/p>\n

* \u06a9\u0634\u06cc\u062f\u0647 \u0634\u062f\u0647 \u062a\u0648\u0633\u0637 \u067e\u0631\u06cc \u062f\u0631\u06cc\u0627\u06cc\u06cc.<\/p>\n

graph TD;
\n subgraph top[“top”]\n subgraph docker[“docker”]\n env[“.env”]\n docker_compose[“docker-compose.yml”]\n end
\n subgraph openapi[“openapi”]\n openapi_file[“openapi.yml”]\n end
\n end<\/p>\n

\u0648\u0627\u0631\u062f \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u0634\u0648\u06cc\u062f<\/p>\n

\u0627\u0632 \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u062e\u0627\u0631\u062c \u0634\u0648\u06cc\u062f<\/p>\n

docker\/.env<\/p>\n

SWAGGER_UI_HOST_PORT={host-port}<\/p>\n

\u0648\u0627\u0631\u062f \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u0634\u0648\u06cc\u062f<\/p>\n

\u0627\u0632 \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u062e\u0627\u0631\u062c \u0634\u0648\u06cc\u062f<\/p>\n

docker\/docker-compose.yml<\/p>\n

services:
\n swagger-ui:
\n image: swaggerapi\/swagger-ui:v5.17.14
\n environment:
\n SWAGGER_JSON: \/oas\/openapi.yml
\n ports:
\n – “${SWAGGER_UI_HOST_PORT}:8080”
\n volumes:
\n – ..\/openapi:\/oas<\/p>\n

\u0648\u0627\u0631\u062f \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u0634\u0648\u06cc\u062f<\/p>\n

\u0627\u0632 \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u062e\u0627\u0631\u062c \u0634\u0648\u06cc\u062f<\/p>\n

openapi\/openapi.yml<\/p>\n

\u062d\u062f\u0627\u0642\u0644 \u0645\u0633\u062a\u0646\u062f\u0627\u062a API \u0645\u0637\u0627\u0628\u0642 \u0628\u0627 OAS 3.0.3 \u0631\u0627 \u062a\u0639\u0631\u06cc\u0641 \u06a9\u0646\u06cc\u062f.<\/p>\n

openapi: 3.0.3
\ninfo:
\n title: Sample API
\n version: 1.0.0
\npaths:
\n \/hello:
\n get:
\n summary: Hello World Request
\n responses:
\n “200”:
\n description: OK
\n content:
\n text\/plain:
\n schema:
\n type: string
\n example: “Hello, World!”<\/p>\n

\u0648\u0627\u0631\u062f \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u0634\u0648\u06cc\u062f<\/p>\n

\u0627\u0632 \u062d\u0627\u0644\u062a \u062a\u0645\u0627\u0645 \u0635\u0641\u062d\u0647 \u062e\u0627\u0631\u062c \u0634\u0648\u06cc\u062f<\/p>\n

\u062f\u0627\u06a9\u0631<\/p>\n

\u06a9\u0627\u0646\u062a\u06cc\u0646\u0631 \u0648 \u062a\u0635\u0648\u06cc\u0631 \u0627\u06cc\u062c\u0627\u062f \u06a9\u0646\u06cc\u062f.<\/p>\n

\u062a\u0631\u0645\u06cc\u0646\u0627\u0644 \u0631\u0627 \u0628\u0627\u0632 \u06a9\u0646\u06cc\u062f.
\n\u062c\u0631\u06cc\u0627\u0646-dir \u0631\u0627 \u0628\u0647 \u0645\u06a9\u0627\u0646\u06cc \u06a9\u0647 \u062f\u0631 \u0622\u0646 \u0642\u0631\u0627\u0631 \u062f\u0627\u0631\u062f \u0645\u0646\u062a\u0642\u0644 \u06a9\u0646\u06cc\u062f docker-compose.yml \u0648\u0627\u0642\u0639 \u0634\u062f\u0647 \u0627\u0633\u062a.<\/p>\n

\u0627\u062c\u0631\u0627\u06cc docker compose create.
\ndocker compose create<\/p>\n

Swagger UI \u0631\u0627 \u0628\u0627\u0632 \u06a9\u0646\u06cc\u062f.<\/p>\n

\u0638\u0631\u0641 \u0631\u0627 \u0631\u0627\u0647 \u0627\u0646\u062f\u0627\u0632\u06cc \u06a9\u0646\u06cc\u062f.
\ndocker compose start<\/p>\n

\u0628\u0627\u0632 \u06a9\u0646\u06cc\u062f http:\/\/localhost:{SWAGGER_UI_HOST_PORT}.<\/p>\n

\u067e\u0633 \u0627\u0632 \u0633\u06cc\u0631 \u0634\u062f\u0646 \u0638\u0631\u0641 \u0631\u0627 \u0645\u062a\u0648\u0642\u0641 \u06a9\u0646\u06cc\u062f.
\ndocker compose stop<\/p>\n

\n
\n
\n

\u0641\u0647\u0631\u0633\u062a \u0645\u0637\u0627\u0644\u0628<\/p>\nToggle<\/span><\/path><\/svg><\/svg><\/span><\/span><\/span><\/a><\/span><\/div>\n