RSS DEV コミュニティ

Swagger UI + Docker:初期設定

環境は、Sonoma 14.6.1 OSで動作するApple M1 CPU搭載のMacと、Docker Desktopバージョン4.34.2で構成されています。このディレクトリー構造には、top、docker、およびopenapiの3つのサブディレクトリーがあります。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ファイルはOAS 3.0.3に準拠する最小のAPIドキュメントを定義しています。ユーザーは、ターミナルでdocker compose createを実行し、次にdocker compose startでコンテナーを起動する必要があります。最後に、ユーザーはブラウザーでhttp://localhost:{SWAGGER_UI_HOST_PORT}を開くことでSwagger UIにアクセスできます。
favicon
dev.to
Swagger UI + Docker: Initial Setup
Create attached notes ...