温馨提示×

debian swagger怎样配置

小樊
46
2026-09-20 00:19:59
栏目: 智能运维

在 Debian 上“配置 Swagger”通常有两种常见场景:

  1. 在 Debian 上部署 Swagger UI(查看/测试已有 API)
  2. 在 Debian 的开发环境中为项目(如 Java/Spring、Python/FastAPI、Node 等)集成 Swagger

下面我分别说明,你可以按需选择。


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

1. 安装依赖

sudo apt update
sudo apt install -y nginx curl

2. 下载 Swagger UI

cd /var/www
sudo curl -L https://github.com/swagger-api/swagger-ui/archive/refs/heads/master.tar.gz -o swagger-ui.tar.gz
sudo tar -xzf swagger-ui.tar.gz
sudo mv swagger-ui-master swagger-ui

3. 配置 Nginx

编辑 Nginx 配置:

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

示例配置:

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

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

    location / {
        try_files $uri $uri/ /index.html;
    }
}

启用配置:

sudo ln -s /etc/nginx/sites-available/swagger /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl restart nginx

4. 修改默认 API 地址

编辑:

/var/www/swagger-ui/dist/swagger-initializer.js

修改:

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

改成你自己的 swagger.jsonopenapi.yaml 地址。


二、Spring Boot 项目集成 Swagger(Debian 开发环境)

1. 安装 Java & Maven

sudo apt install -y openjdk-17-jdk maven

2. 添加依赖(Springdoc,推荐)

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

3. 访问地址

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

三、Python(FastAPI)在 Debian 上配置 Swagger

FastAPI 自带 Swagger:

pip install fastapi uvicorn
from fastapi import FastAPI

app = FastAPI()

@app.get("/items")
def read_items():
    return [{"id": 1}]

运行:

uvicorn main:app --host 0.0.0.0 --port 8000

访问:

http://服务器IP:8000/docs

四、常见问题

  • 端口无法访问:检查防火墙
    sudo ufw allow 80
    
  • Swagger 空白:通常是 swagger.json 跨域或路径错误
  • 生产环境:建议加 Nginx + HTTPS

如果你能告诉我:

  • 用的是 哪种语言/框架
  • 本地开发 还是 服务器部署

我可以给你更精确的 Debian 配置方案。

0