温馨提示×

Debian下Swagger文档在哪

小樊
65
2025-05-28 07:18:43
栏目: 智能运维

在Debian系统下,Swagger文档可以通过以下几种方式获取和访问:

通过Spring Boot项目访问Swagger文档

如果你在Debian系统上使用Spring Boot框架,可以通过以下步骤访问Swagger文档:

  1. 创建Spring Boot项目
  • 使用 Spring Initializr 创建一个新的Spring Boot项目,并添加 springfox-boot-starter 依赖。
  1. 配置Swagger
  • application.ymlapplication.properties 文件中配置Swagger。例如,在 application.yml 中添加:
    springfox: documentation: swagger-ui: enabled: true 
  1. 启动项目
  • 使用 mvn spring-boot:run 命令启动你的Spring Boot项目。
  1. 访问Swagger UI
  • 项目启动后,打开浏览器,访问 http://localhost:8080/swagger-ui/ 即可查看Swagger生成的API文档。

通过Docker部署Swagger UI

如果你更喜欢使用Docker来部署Swagger UI,可以按照以下步骤操作:

  1. 安装Docker
  • 如果还没有安装Docker,可以使用以下命令安装:
    sudo apt update sudo apt install docker.io 
  1. 拉取Swagger UI镜像
  • 使用以下命令从Docker Hub拉取Swagger UI镜像:
    docker pull swaggerapi/swagger-ui 
  1. 运行Swagger UI容器
  • 运行一个容器并映射端口(例如8080):
    docker run -p 8080:8080 -d swaggerapi/swagger-ui 
  1. 访问Swagger UI
  • 打开浏览器并访问 http://your-debian-ip:8080,你应该能看到Swagger UI界面。

通过Nginx和Swagger UI静态文件部署

另一种常见的方法是使用Nginx来部署Swagger UI的静态文件:

  1. 安装Nginx
  • 如果还没有安装Nginx,可以使用以下命令安装:
    sudo apt update sudo apt install nginx 
  1. 下载Swagger UI静态文件
  • 从Swagger UI的GitHub仓库下载静态文件,或者使用以下命令直接下载:
    wget https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/swagger-ui-bundle.js wget https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/swagger-ui-standalone-preset.js wget https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/swagger-ui.css wget https://raw.githubusercontent.com/swagger-api/swagger-ui/master/dist/swagger-ui-extensions.css 
  1. 创建一个目录来存放Swagger UI文件
sudo mkdir -p /var/www/swagger-ui sudo cp swagger-ui-bundle.js swagger-ui-standalone-preset.js swagger-ui.css swagger-ui-extensions.css /var/www/swagger-ui/ 
  1. 配置Nginx
  • 编辑Nginx配置文件 /etc/nginx/sites-available/default,添加以下内容:
    server { listen 80; server_name your-debian-ip; location /swagger-ui/ { root /var/www/swagger-ui; try_files $uri $uri/ /swagger-ui/index.html; } } 
  1. 重启Nginx
sudo systemctl restart nginx 
  1. 访问Swagger UI
  • 打开浏览器并访问 http://your-debian-ip/swagger-ui/,你应该能看到Swagger UI界面。

通过以上几种方法,你可以在Debian系统下成功访问和使用Swagger文档。选择适合你的方法进行部署即可。

0