温馨提示×

Linux下Swagger怎么访问

小樊
35
2026-08-21 04:37:51
栏目: 智能运维

在 Linux 下“访问 Swagger”通常指 访问 Swagger UI 或 Swagger 生成的 API 文档。具体方式取决于你是 Spring Boot / Node / Python / 手动部署 等场景。下面按常见情况说明。


一、Spring Boot(最常见)

1️⃣ Springfox Swagger(老项目)

访问地址:

http://服务器IP:端口/swagger-ui.html

例如:

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

如果访问不到,检查:

  • 是否引入依赖
  • 是否被拦截(Spring Security)

Maven 依赖

<dependency>
  <groupId>io.springfox</groupId>
  <artifactId>springfox-boot-starter</artifactId>
  <version>3.0.0</version>
</dependency>

放行路径(Spring Security)

.antMatchers("/swagger-ui.html", "/webjars/**", "/v2/api-docs").permitAll()

2️⃣ SpringDoc OpenAPI(新项目,推荐 ✅)

访问地址:

http://服务器IP:端口/swagger-ui.html

http://服务器IP:端口/swagger-ui/index.html

Maven 依赖

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

✅ 不需要额外配置即可访问


二、Linux 服务器访问注意事项

✅ 防火墙

# 查看端口
ss -lntp | grep 8080

# 开放端口
firewall-cmd --add-port=8080/tcp --permanent
firewall-cmd --reload

✅ 云服务器

  • 安全组放行端口(如 8080、8888)

三、Swagger JSON 接口访问

Swagger 文档本质是一个 JSON:

http://localhost:8080/v2/api-docs

或(SpringDoc):

http://localhost:8080/v3/api-docs

你可以:

  • 浏览器直接访问
  • 导入到 Postman / Apifox / Swagger Editor

四、手动部署 Swagger UI(非 Java)

1️⃣ 下载 Swagger UI

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

2️⃣ 用 Nginx 访问

server {
    listen 80;
    server_name localhost;

    location / {
        root /opt/swagger-ui/dist;
        index index.html;
    }
}

访问:

http://服务器IP

五、Docker 中访问 Swagger

docker run -p 8080:8080 your-image

访问:

http://服务器IP:8080/swagger-ui.html

六、常见问题排查

问题 原因
404 Swagger 路径错误
403 Spring Security 拦截
无法访问 防火墙 / 安全组
空白页 JS 加载失败

七、快速确认方式 ✅

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

如果返回 HTML,说明服务正常。


如果你愿意,可以告诉我:

  • ✅ 使用的语言(Java / Python / Node)
  • ✅ 框架(Spring Boot / Flask / Express)
  • ✅ 是否部署在 Docker / 云服务器

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

0