Debian如何启Swagger

debian

小樊

2026-09-28 20:48:15

栏目: 智能运维

在 Debian 上“启用 Swagger”通常取决于你使用的是哪种技术栈。Swagger 不是一个系统服务，而是一套 API 文档规范 + 工具。下面按常见情况说明。

一、最常见的理解：Spring Boot 项目启用 Swagger

如果你在 Debian 上运行的是 Java / Spring Boot 应用：

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>

新项目推荐用 springdoc-openapi（更现代）：

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

2. 启用 Swagger

@Configuration
@EnableSwagger2   // 或 springdoc 不需要此注解
public class SwaggerConfig {}

3. 访问地址

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

或（springdoc）：

/swagger-ui/index.html

二、Node.js（Express）项目启用 Swagger

1. 安装

npm install swagger-ui-express

2. 使用

const swaggerUi = require('swagger-ui-express');
app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

访问：

http://IP:3000/api-docs

三、Python（FastAPI / Flask）

FastAPI（内置 Swagger）

from fastapi import FastAPI
app = FastAPI()

访问：

/docs

Flask

pip install flask-restx

四、Debian 系统层面注意事项

防火墙

sudo ufw allow 8080

服务运行

nohup java -jar app.jar &

或 systemd 管理

反向代理（Nginx）

location /swagger-ui.html {
    proxy_pass http://127.0.0.1:8080;
}

五、请告诉我

为了给你准确步骤，请说明：

你用的是什么语言/框架？
是本地服务还是服务器？
报错信息或当前访问不了的现象？

我可以一步步帮你配置。