温馨提示×

ubuntu怎样部署swagger服务

小樊
43
2026-10-21 11:13:10
栏目: 智能运维

在 Ubuntu 上“部署 Swagger 服务”通常有三种常见场景,下面我按最常见、最实用的方式给你说明,你可以按需选择。


一、部署 Swagger UI(最常用,查看/调试 API)

适合: 已有 OpenAPI/Swagger JSON/YAML 文件,想在网页上展示

1. 安装依赖

sudo apt update
sudo apt install -y nginx nodejs npm

2. 下载 Swagger UI

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

3. 配置 Nginx

sudo vim /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/sh/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://your-api/swagger.json"

浏览器访问:

http://服务器IP

二、Spring Boot + Swagger(开发常见)

适合: Java 后端自动生成 Swagger

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>

2. 启动后访问

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

三、Swagger Editor(编写 API 文档)

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

访问:

http://服务器IP:8080

四、常见问题

端口打不开?

sudo ufw allow 80
sudo ufw allow 8080

想用 HTTPS?

用 Nginx + Let’s Encrypt:

sudo apt install certbot python3-certbot-nginx
sudo certbot --nginx

总结

场景 推荐方式
查看已有 API Swagger UI
Java 项目 Springfox
编写 API Swagger Editor

如果你能告诉我:

  • 是 Java / Node / Python?
  • 是 查看文档 还是 自动生成?

我可以给你更精确的部署步骤。

0 踩