温馨提示×

debian上swagger怎么用

小樊
46
2026-09-16 21:06:19
栏目: 智能运维

在 Debian 上使用 Swagger,通常有两种常见场景:

  1. Swagger UI(查看/调试 API)
  2. Swagger 代码生成(OpenAPI → 代码)

下面分别说明,假设你用的是 Debian 11/12。


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

方式 1:直接下载静态文件(最简单)

sudo apt update
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/html/swagger

sudo systemctl start nginx

浏览器访问:

http://<你的IP>/swagger

修改默认 API 地址:

sudo nano /var/www/html/swagger/swagger-initializer.js

改成你的 OpenAPI 地址:

url: "http://localhost:8080/v3/api-docs",

方式 2:Docker 方式(推荐)

sudo apt install -y docker.io
sudo systemctl start docker

docker run -d -p 8080:8080 \
  -e SWAGGER_JSON=/foo/openapi.yaml \
  -v $PWD/openapi.yaml:/foo/openapi.yaml \
  swaggerapi/swagger-ui

访问:

http://localhost:8080

二、使用 Swagger Editor(编写 OpenAPI)

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

访问:

http://localhost:8081

三、Swagger Codegen(生成客户端/服务端代码)

安装(Debian)

sudo apt install -y default-jre wget

wget https://repo1.maven.org/maven2/io/swagger/codegen/v3/swagger-codegen-cli/3.0.52/swagger-codegen-cli-3.0.52.jar

生成代码示例

java -jar swagger-codegen-cli-3.0.52.jar generate \
  -i openapi.yaml \
  -l spring \
  -o ./generated

支持语言:

  • spring
  • python
  • go
  • typescript-axios
  • java

四、在 Spring Boot 项目中使用 Swagger(开发常用)

Maven 依赖

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

访问:

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

五、常见问题

1. 页面打不开?

  • 检查 nginx / docker 是否运行
  • 防火墙:sudo ufw allow 80

2. 跨域问题?

Swagger UI 访问远程 API 时,API 需允许 CORS。


六、推荐组合(实战)

用途 推荐
查看 API Swagger UI
编写 API Swagger Editor
生成代码 Swagger Codegen
Spring Boot springdoc-openapi

如果你能告诉我:

  • 是 Java / Python / Go?
  • 是 看 API 还是 生成代码?

我可以给你更精确的 Debian 操作步骤。

0 踩