温馨提示×

Linux Swagger怎么启动

小樊
49
2026-08-05 21:25:00
栏目: 智能运维

在 Linux 上启动 Swagger 取决于你使用的是哪种 Swagger 相关工具。下面按最常见场景给你说明,基本都能覆盖 90% 的情况。


一、Swagger UI(最常见 ✅)

方式一:用 Docker 启动(最简单,推荐)

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

访问:

http://localhost:8080

✅ 适合:查看已有 Swagger / OpenAPI 文档


方式二:下载 Swagger UI(无 Docker)

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
python3 -m http.server 8080

访问:

http://localhost:8080

二、Spring Boot 项目中的 Swagger(springdoc / Swagger2)

1️⃣ 使用 springdoc-openapi(✅ 推荐)

依赖:

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

启动项目后访问:

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

或:

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

2️⃣ 老项目 Swagger2(不太推荐)

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

访问:

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

⚠️ Swagger2 已停止维护


三、Node.js / Express 项目

npm install swagger-ui-express swagger-jsdoc
const swaggerJsdoc = require('swagger-jsdoc');
const swaggerUi = require('swagger-ui-express');

const app = require('express')();

const spec = swaggerJsdoc({ definition: { openapi: '3.0.0' }, apis: ['./index.js'] });

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(spec));
app.listen(3000);

访问:

http://localhost:3000/api-docs

四、Swagger Editor(写 API 文档)

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

访问:

http://localhost:8081

五、常见问题

❓ 访问不了?

curl http://localhost:8080

检查:

  • 端口是否被占用
  • 防火墙
  • 是否使用了 Docker

六、快速判断你该用哪个

场景 推荐
只看接口文档 Swagger UI
Spring Boot springdoc-openapi
写 OpenAPI Swagger Editor
前端项目 swagger-jsdoc

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

  • ✅ 用的什么语言(Java / Node / Python)
  • ✅ 框架(Spring Boot / Express / FastAPI)
  • ✅ 想“看文档”还是“生成文档”

我可以一步一步帮你配 ✅

0