温馨提示×

linux swagger如何备份

小樊
46
2026-08-31 16:26:52
栏目: 智能运维

在 Linux 环境下,“Swagger 备份”通常指备份 Swagger/OpenAPI 文档、配置文件或 Swagger UI 相关资源。不同场景备份方式不同,下面按最常见情况给你一套实用方案。


一、明确你指的“Swagger”是什么

常见有 4 类:

  1. Swagger / OpenAPI YAML / JSON 文件
  2. Swagger UI 静态页面
  3. Spring Boot / 微服务中的 Swagger 接口
  4. Docker 容器中运行的 Swagger

我会分别说明。


二、备份 Swagger OpenAPI 文档(最常见 ✅)

1️⃣ 找到 Swagger 文档路径

常见位置:

/api-docs
/v2/api-docs
/v3/api-docs
/swagger/v1/swagger.json

也可以直接访问:

http://服务器IP:端口/v3/api-docs

2️⃣ 使用 curl 备份

curl http://localhost:8080/v3/api-docs -o swagger-backup.json

如果是 YAML:

curl http://localhost:8080/v3/api-docs.yaml -o swagger-backup.yaml

✅ 推荐:纳入 Git 或定时备份


三、备份 Swagger UI(前端页面)

1️⃣ 找到 Swagger UI 目录

常见路径:

/usr/share/swagger-ui
/var/www/swagger-ui

2️⃣ 打包备份

tar -czvf swagger-ui-backup-$(date +%F).tar.gz /path/to/swagger-ui

四、备份 Spring Boot 项目中的 Swagger

1️⃣ 备份配置文件

cp application.yml application.yml.bak
cp application.properties application.properties.bak

2️⃣ 备份接口文档(运行时)

curl http://localhost:8080/v3/api-docs > swagger-$(date +%F).json

3️⃣ 源码级备份(推荐)

git add .
git commit -m "Backup Swagger config"
git push

五、Docker 中的 Swagger 备份

1️⃣ 进入容器

docker exec -it 容器名 /bin/bash

2️⃣ 导出 Swagger 文档

curl http://localhost:8080/v3/api-docs -o /tmp/swagger.json

3️⃣ 拷贝到宿主机

docker cp 容器名:/tmp/swagger.json /backup/swagger.json

六、自动定时备份(推荐 ✅)

使用 cron

crontab -e

每天凌晨 2 点备份:

0 2 * * * curl -s http://localhost:8080/v3/api-docs -o /backup/swagger-$(date +\%F).json

七、推荐备份策略 ✅

类型 备份方式
Swagger 文档 导出 JSON/YAML
配置 Git + 文件备份
UI tar 打包
容器 docker cp + 卷备份
自动化 cron / CI

八、如果你愿意,我可以进一步帮你

你可以直接告诉我:

  • ✅ Swagger 是 Spring Boot / Node / Python / Docker 哪种?
  • ✅ 想备份的是 接口文档 / UI / 配置
  • ✅ 是否要 自动备份 + 恢复方案

我可以给你精确到命令级别的方案。

0