Ubuntu Swagger如何与Docker集成

Ubuntu环境下Swagger与Docker集成的详细步骤

1. 准备工作：安装Docker

在Ubuntu系统上集成Swagger与Docker前，需先安装Docker。打开终端，执行以下命令完成安装：

sudo apt update
sudo apt install -y docker.io
sudo systemctl start docker  # 启动Docker服务
sudo systemctl enable docker # 设置开机自启

安装完成后，可通过docker --version验证是否安装成功。

2. 拉取Swagger官方Docker镜像

Swagger提供了官方Docker镜像，包含Swagger Editor（编辑器）和Swagger UI（文档展示界面）。执行以下命令拉取最新版本镜像：

docker pull swaggerapi/swagger-editor:v4.6.0  # 拉取Swagger Editor镜像
docker pull swaggerapi/swagger-ui:v4.15.5     # 拉取Swagger UI镜像

若需特定版本，可将v4.6.0、v4.15.5替换为目标版本号。

3. 运行Swagger容器

3.1 单独运行Swagger Editor

通过docker run命令启动Swagger Editor容器，将容器内部的8080端口映射到宿主机的38080端口（可根据需求修改端口）：

docker run -d -p 38080:8080 swaggerapi/swagger-editor:v4.6.0

参数说明：-d表示后台运行，-p用于端口映射。

3.2 单独运行Swagger UI

同样方式启动Swagger UI容器，将宿主机38081端口映射到容器8080端口：

docker run -d -p 38081:8080 swaggerapi/swagger-ui:v4.15.5

3.3 同时运行Editor与UI（多容器模式）

若需同时运行两个服务，可分别执行上述两条docker run命令，或通过docker-compose简化管理（详见后续步骤）。

4. 访问Swagger服务

打开浏览器，输入以下地址访问对应服务：

• Swagger Editor：http://localhost:38080（用于编写、编辑Swagger YAML/JSON文件）
• Swagger UI：http://localhost:38081（用于可视化展示、测试API文档）

若需从本地导入Swagger配置文件（如swagger.yaml），可在Swagger Editor界面点击左上角「File」→「Import File」选择文件即可。

5. 可选：使用Docker Compose管理多容器

若需同时运行Swagger Editor和Swagger UI，并简化启动流程，可使用Docker Compose。步骤如下：

5.1 创建docker-compose.yml文件

在项目目录下创建docker-compose.yml文件，内容如下：

version: '3.9'
services:
  swagger-editor:
    image: swaggerapi/swagger-editor:v4.6.0
    ports:
      - "38080:8080"
  swagger-ui:
    image: swaggerapi/swagger-ui:v4.15.5
    ports:
      - "38081:8080"

5.2 启动服务

在docker-compose.yml所在目录执行以下命令：

docker-compose up -d

该命令会自动拉取镜像（若未拉取）并启动两个容器，-d表示后台运行。

注意事项

• 端口冲突：若宿主机38080、38081端口已被占用，可将-p参数中的端口号修改为其他未被使用的端口（如38082:8080）。
• 镜像更新：定期通过docker pull命令更新Swagger镜像，以获取最新功能和安全补丁。
• 数据持久化：若需保存Swagger配置文件的修改，可通过-v参数挂载宿主机目录到容器（如-v /host/path:/container/path），避免容器重启后数据丢失。