温馨提示×

如何安装Linux Swagger

小樊
37
2026-08-05 20:33:04
栏目: 智能运维

在 Linux 上安装 Swagger,通常指安装 Swagger UI(用于查看 API 文档)或 Swagger Editor(在线编写 OpenAPI 文档)。下面给你几种常用、推荐的方式。


一、安装 Swagger UI(最常用)

✅ 方式 1:使用 Docker(最简单、推荐)

1. 安装 Docker(如果还没装)

sudo apt update
sudo apt install docker.io -y
sudo systemctl start docker
sudo systemctl enable docker

2. 运行 Swagger UI

docker run -p 8080:8080 swaggerapi/swagger-ui

浏览器访问:

http://localhost:8080

✅ 支持加载本地/远程 OpenAPI 文件
✅ 不影响系统环境


✅ 方式 2:直接用 Nginx / 静态文件(适合生产)

1. 下载 Swagger UI

wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v5.17.14.zip
unzip v5.17.14.zip
cd swagger-ui-5.17.14/dist

2. 用 Nginx 部署

sudo cp -r dist /var/www/swagger-ui

Nginx 配置:

server {
    listen 8080;
    location / {
        root /var/www/swagger-ui;
        index index.html;
    }
}

访问:

http://服务器IP:8080

二、安装 Swagger Editor(编写 API 文档)

✅ 使用 Docker(推荐)

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

访问:

http://localhost:8081

三、安装 Swagger Codegen(生成客户端/服务端代码)

⚠️ 官方已分裂为 CodegenOpenAPI Generator

✅ OpenAPI Generator(推荐)

sudo apt install openjdk-17-jdk -y
wget https://repo1.maven.org/maven2/org/openapitools/openapi-generator-cli/7.8.0/openapi-generator-cli-7.8.0.jar

使用:

java -jar openapi-generator-cli-7.8.0.jar generate \
  -i swagger.yaml \
  -g java \
  -o ./out

四、在 Java / Spring Boot 项目中使用 Swagger(Springdoc)

如果你是 Spring Boot 3

Maven

<dependency>
  <groupId>org.springdoc</groupId>
  <artifactId>springdoc-openapi-starter-webmvc-ui</artifactId>
  <version>2.5.0</version>
</dependency>

访问:

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

五、常见问题

❓ 如何加载本地 YAML / JSON?

在 Swagger UI 中修改 URL:

./openapi.yaml

http://localhost:8080/api-docs

六、推荐组合(最省事)

本地开发

  • Swagger Editor(Docker)
  • Swagger UI(Docker)

后端 API

  • Springdoc OpenAPI(Spring Boot)
  • 自动生成文档

如果你能告诉我:

  • ✅ 是 Docker / 非 Docker
  • ✅ 想生成文档还是查看文档
  • ✅ 后端语言(Java / Python / Go / Node)

我可以给你更精确的命令和配置

0