linux

Swagger如何在Linux服务器上部署

小樊
37
2025-02-21 06:30:41
栏目: 云计算

在Linux服务器上部署Swagger可以通过多种方式实现,以下是使用Docker容器化部署的步骤,这种方式简化了安装过程并提供了灵活的远程访问能力。

使用Docker部署Swagger Editor和Swagger UI

  1. 安装Docker: 如果你还没有安装Docker,首先需要在你的Linux服务器上安装它。可以参考Docker官方文档进行安装Docker安装指南

  2. 部署Swagger Editor

    • 拉取Swagger Editor镜像:
      docker pull swaggerapi/swagger-editor:v4.6.0
      
    • 运行Swagger Editor容器,并将容器的8080端口映射到宿主机的8088端口:
      docker run -d -p 8088:8080 swaggerapi/swagger-editor:v4.6.0
      
    • 现在,你可以在本地浏览器中访问http://<你的服务器IP>:8088来查看Swagger Editor界面。
  3. 部署Swagger UI

    • 拉取Swagger UI镜像:
      docker pull swaggerapi/swagger-ui:v4.15.5
      
    • 运行Swagger UI容器,并将容器的8080端口映射到宿主机的8080端口:
      docker run -d -p 8080:8080 swaggerapi/swagger-ui:v4.15.5
      
    • 在浏览器中访问http://<你的服务器IP>:8080来查看Swagger UI界面。

使用Cpolar实现远程访问

  1. 安装Cpolar

    • 安装Cpolar工具,它可以帮助我们将本地端口映射到公网地址,实现远程访问。可以参考Cpolar官网获取安装命令。
  2. 配置Swagger Editor公网地址

    • 在Swagger Editor中,点击左侧仪表盘的隧道管理,创建一个公网地址隧道。
    • 配置隧道后,你将获得一个公网地址,可以通过该地址远程访问Swagger Editor。
  3. 固定公网地址(可选):

    • 如果你需要一个固定且永久不变的公网地址,可以在Cpolar中配置二级子域名,这样地址就不会随机变化。Cpolar固定公网地址教程

使用Apache或Nginx作为Web服务器

如果你更喜欢使用传统的Web服务器,可以配置Apache或Nginx来托管Swagger UI和Swagger Editor。

  1. 配置Apache

    • 安装Apache并启用默认站点配置:
      sudo a2ensite default.conf
      sudo systemctl restart apache2
      
    • 编辑/etc/apache2/sites-available/default文件,确保DocumentRoot指向Swagger UI和Swagger Editor的文件位置。
  2. 配置Nginx

    • 安装Nginx并配置站点:
      sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.backup
      sudo nano /etc/nginx/sites-available/default
      
    • 修改server块中的rootindex指令,然后重启Nginx:
      sudo systemctl restart nginx
      

通过以上步骤,你可以在Linux服务器上成功部署Swagger,并实现本地或远程访问。选择适合你的方式,并根据需要进行调整。

0
看了该问题的人还看了