温馨提示×

debian swagger怎么接入项目

小樊
46
2026-10-10 14:35:17
栏目: 智能运维

下面以 Debian 系统 为背景,说明 Swagger 如何接入项目。Swagger 本身是一套规范,常见实现是 OpenAPI + Swagger UI / Swagger Editor,不同语言接入方式不同。我按常见场景给你讲。


一、先明确你的项目类型

在 Debian 上常见情况:

  1. Java(Spring Boot)
  2. Node.js(Express / NestJS)
  3. Python(FastAPI / Flask)
  4. 纯静态接口文档(Swagger UI)

你可以对号入座。


二、通用方式(不依赖语言):Swagger UI 静态接入

适合:

  • 已有 OpenAPI 文件(swagger.json / openapi.yaml)
  • 只想在 Debian 上展示接口文档

1. 安装 Nginx(Debian)

sudo apt update
sudo apt install nginx -y

2. 下载 Swagger UI

cd /var/www
sudo git clone https://github.com/swagger-api/swagger-ui.git

3. 配置 Nginx

server {
    listen 80;
    server_name api.example.com;

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

4. 修改默认 API 地址

编辑:

/var/www/swagger-ui/dist/index.html

找到:

url: "https://petstore.swagger.io/v2/swagger.json"

改成你的:

url: "/swagger.json"

然后访问:

http://服务器IP

三、Spring Boot 项目接入(最常用)

1. 添加依赖

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

2. 启动后访问

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

3. Debian 上运行

java -jar your-app.jar

四、Node.js(Express)接入

1. 安装

npm install swagger-ui-express

2. 代码接入

const swaggerUi = require('swagger-ui-express');
const swaggerDocument = require('./swagger.json');

app.use('/api-docs', swaggerUi.serve, swaggerUi.setup(swaggerDocument));

访问:

http://localhost:3000/api-docs

五、Python(FastAPI,最省事)

from fastapi import FastAPI
from fastapi.openapi.docs import get_swagger_ui_html

app = FastAPI()

@app.get("/docs", include_in_schema=False)
async def custom_swagger_ui():
    return get_swagger_ui_html("/openapi.json", "API Docs")

默认已自带:

/docs

六、常见坑(Debian 环境)

  • 防火墙:记得放行 80 / 端口
  • 权限问题:/var/www 用 www-data
  • 跨域:Swagger JSON 需允许 CORS
  • 生产环境:建议加认证,别裸奔

七、你可以告诉我

为了给你更精准的步骤,你可以说:

  • 你用的是什么语言 / 框架?
  • 是已有接口还是从零开始?
  • 想用 Swagger UI 还是自动生成?

我可以直接给你 可复制的 Debian 配置。

0 踩