DEV Community
·
Swagger UI + Docker：初始设置
内容提要
文章介绍了在Apple M1和Sonoma系统上使用Docker Desktop设置Swagger UI的步骤。目录结构包括`.env`和`docker-compose.yml`文件。通过指定Swagger UI镜像版本和环境变量，配置端口8080，并共享主机与容器之间的OAS文件。文章还展示了如何定义符合OAS 3.0.3的API文档，并通过Docker命令创建和启动容器，访问Swagger UI界面。
关键要点
-
文章介绍了在Apple M1和Sonoma系统上使用Docker Desktop设置Swagger UI的步骤。
-
目录结构包括.env和docker-compose.yml文件。
-
通过指定Swagger UI镜像版本和环境变量，配置端口8080，并共享主机与容器之间的OAS文件。
-
定义符合OAS 3.0.3的API文档，包括基本信息和路径。
-
使用Docker命令创建和启动容器，访问Swagger UI界面。
-
在终端中执行docker compose create和docker compose start命令来创建和启动容器。
-
访问Swagger UI界面后，可以通过docker compose stop命令停止容器。
延伸解读
Docker与Swagger UI的结合
使用Docker Desktop设置Swagger UI可以简化API文档的管理和展示。通过容器化，开发者可以轻松地在不同环境中部署和运行Swagger UI，确保一致性和可移植性。特别是在Apple M1和Sonoma系统上，Docker的支持使得这一过程更加顺畅。
环境变量的重要性
在配置Swagger UI时，环境变量的设置至关重要。通过`.env`文件定义主机端口，可以灵活地调整Swagger UI的访问地址。这种方法不仅提高了配置的灵活性，还能避免硬编码，增强了项目的可维护性。
OAS文件的共享
共享OAS文件是Docker与主机之间的关键环节。通过将OAS文件映射到容器内，开发者可以实时更新API文档，而无需重新构建容器。这种动态更新的能力使得API文档的维护更加高效，尤其在快速迭代的开发环境中尤为重要。
延伸问答
如何在Apple M1和Sonoma系统上设置Swagger UI？
可以通过Docker Desktop设置Swagger UI，首先创建包含.env和docker-compose.yml文件的目录结构，然后配置Swagger UI镜像版本和环境变量，最后使用Docker命令创建和启动容器。
Swagger UI的docker-compose.yml文件中需要配置哪些内容？
需要配置Swagger UI镜像、环境变量SWAGGER_JSON、端口映射以及共享OAS文件的卷。
如何定义符合OAS 3.0.3的API文档？
可以在openapi.yml文件中定义API文档，包括基本信息和路径，例如定义一个返回'Hello, World!'的GET请求。
如何启动和停止Swagger UI容器？
在终端中执行'docker compose create'命令创建容器，使用'docker compose start'命令启动容器，访问后可以用'docker compose stop'命令停止容器。
在Docker中如何共享主机与容器之间的OAS文件？
通过在docker-compose.yml文件中配置卷，将主机上的OAS文件路径映射到Docker容器内的指定路径。
Swagger UI的默认端口是什么？
Swagger UI的默认端口是8080。
