DEV Community
·
Swagger UI + Docker：初始设置
💡
原文英文，约300词，阅读约需2分钟。
📝
内容提要
文章介绍了在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命令停止容器。
❓
延伸问答
如何在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。
➡️
