温馨提示×

如何导入linux swagger文档

小樊
35
2026-10-15 09:12:52
栏目: 智能运维

在 Linux 环境下“导入 Swagger 文档”通常有几种常见场景,我按最常见用法给你说明,你可以对号入座。


一、在 Swagger UI 中导入 Swagger 文档(最常用)

1️⃣ 准备 Swagger 文档

Swagger 文档一般是以下格式之一:

  • swagger.json
  • swagger.yaml
  • openapi.yaml(OpenAPI 3.x)

确保文件在 Linux 服务器上,例如:

/opt/swagger/swagger.json

2️⃣ 安装 Swagger UI(Linux)

方式一:Docker(推荐)

docker run -p 8080:8080 \
  -e SWAGGER_JSON=/swagger/swagger.json \
  -v /opt/swagger:/swagger \
  swaggerapi/swagger-ui

访问:

http://服务器IP:8080

方式二:Nginx + Swagger UI

wget https://github.com/swagger-api/swagger-ui/archive/refs/heads/master.zip
unzip master.zip
cp -r swagger-ui-master/dist /usr/share/nginx/html/swagger

修改:

/usr/share/nginx/html/swagger/swagger-initializer.js
url: "swagger.json"

把你的 swagger.json 放到该目录。


二、在 Spring Boot 项目中导入 Swagger(Java 项目)

1️⃣ 引入依赖(Maven)

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger2</artifactId>
  <version>3.0.0</version>
</dependency>
<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-swagger-ui</artifactId>
  <version>3.0.0</version>
</dependency>

2️⃣ 启动后访问

http://localhost:8080/swagger-ui/

三、使用命令行工具导入(如 Swagger Codegen / Editor)

Swagger Editor

docker run -p 8081:8080 swaggerapi/swagger-editor

打开后:

  • File → Import File → 选择 swagger.json

四、导入到 API 网关 / Postman

  • Postman:Import → File → 选择 swagger.json
  • Kong / APISIX:通过 admin API 导入 OpenAPI

五、常见问题

✅ 文件权限问题

chmod 644 swagger.json

✅ 格式错误

python -m json.tool swagger.json

如果你能告诉我:

  • 是 Docker / Nginx / Spring Boot
  • 是 查看文档 还是 生成代码

我可以给你更精确的命令。

0 踩