温馨提示×

如何给debian加swagger

小樊
47
2026-10-16 09:28:34
栏目: 智能运维

在 Debian 上“加 Swagger”通常指两种情况之一:

  1. 给后端服务加 Swagger(API 文档)(如 Java/Spring、Node、Python 等)
  2. 在 Debian 上部署 Swagger UI / Swagger Editor(作为静态服务或容器)

下面按常见场景说明。


一、在 Debian 上部署 Swagger UI(最常用)

方式 1:用 Docker(推荐)

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

docker run -d -p 8080:8080 \
  -e SWAGGER_JSON=/foo/swagger.json \
  -v /path/to/swagger.json:/foo/swagger.json \
  swaggerapi/swagger-ui

访问:

http://<debian-ip>:8080

方式 2:用 Nginx + 静态文件

sudo apt install -y nginx unzip wget

cd /tmp
wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v5.17.14.zip
unzip v5.17.14.zip
sudo cp -r swagger-ui-5.17.14/dist /var/www/swagger

sudo nano /etc/nginx/sites-enabled/swagger

Nginx 配置示例:

server {
    listen 80;
    server_name swagger.local;

    root /var/www/swagger;
    index index.html;

    location / {
        try_files $uri $uri/ /index.html;
    }
}
sudo nginx -t
sudo systemctl reload nginx

修改 dist/swagger-initializer.js 中的 url 指向你的 swagger.json。


二、在后端项目中集成 Swagger

Spring Boot(Java)

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

访问:

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

Node.js (Express)

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

Python (FastAPI)

pip install fastapi uvicorn

自带 Swagger:

http://localhost:8000/docs

三、常见用途建议

场景 推荐方式
只看 API 文档 Nginx + Swagger UI
微服务 Docker
开发联调 后端集成
离线环境 静态 dist 部署

如果你能告诉我:

  • Debian 版本
  • 后端语言/框架
  • 是否允许 Docker

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

0 踩