Swagger UI + Docker: Initial Setup

Summarize this content to 400 words in Persian Lang

محیط زیست

مک

CPU: Apple M1
سیستم عامل: Sonoma 14.6.1

Docker Desktop

ساختار دیر

* کشیده شده توسط پری دریایی.

graph TD;
subgraph top[“top”] subgraph docker[“docker”] env[“.env”] docker_compose[“docker-compose.yml”] end
subgraph openapi[“openapi”] openapi_file[“openapi.yml”] end
end

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

docker/.env

SWAGGER_UI_HOST_PORT={host-port}

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

docker/docker-compose.yml

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

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

openapi/openapi.yml

حداقل مستندات API مطابق با OAS 3.0.3 را تعریف کنید.

openapi: 3.0.3
info:
title: Sample API
version: 1.0.0
paths:
/hello:
get:
summary: Hello World Request
responses:
“200”:
description: OK
content:
text/plain:
schema:
type: string
example: “Hello, World!”

وارد حالت تمام صفحه شوید

از حالت تمام صفحه خارج شوید

داکر

کانتینر و تصویر ایجاد کنید.

ترمینال را باز کنید.
جریان-dir را به مکانی که در آن قرار دارد منتقل کنید docker-compose.yml واقع شده است.

اجرای docker compose create.
docker compose create

Swagger UI را باز کنید.

ظرف را راه اندازی کنید.
docker compose start

باز کنید http://localhost:{SWAGGER_UI_HOST_PORT}.

پس از سیر شدن ظرف را متوقف کنید.
docker compose stop

graph TD;
    subgraph top["top"]
        subgraph docker["docker"]
            env[".env"]
            docker_compose["docker-compose.yml"]
        end
        subgraph openapi["openapi"]
            openapi_file["openapi.yml"]
        end
    end

SWAGGER_UI_HOST_PORT={host-port}

services:
  swagger-ui:
    image: swaggerapi/swagger-ui:v5.17.14
    environment:
      SWAGGER_JSON: /oas/openapi.yml
    ports:
      - "${SWAGGER_UI_HOST_PORT}:8080"
    volumes:
      - ../openapi:/oas

openapi: 3.0.3
info:
  title: Sample API
  version: 1.0.0
paths:
  /hello:
    get:
      summary: Hello World Request
      responses:
        "200":
          description: OK
          content:
            text/plain:
              schema:
                type: string
                example: "Hello, World!"