Hello! 欢迎来到小浪云!


Swagger如何在Linux服务器上部署


Swagger如何在Linux服务器上部署

本文介绍如何在Linux服务器上部署Swagger,重点讲解使用docker容器化部署,这是一种便捷且灵活的方案,支持远程访问。

Docker容器化部署Swagger Editor和Swagger ui

  1. 安装Docker: 首先,确保你的Linux服务器已安装Docker。 参考Docker官方文档Docker安装指南进行安装。

  2. 部署Swagger Editor:

    • 拉取镜像: docker pull swaggerapi/swagger-editor:v4.6.0
    • 运行容器,将容器的8080端口映射到宿主机的8088端口:docker run -d -p 8088:8080 swaggerapi/swagger-editor:v4.6.0
    • 通过浏览器访问http://你的服务器IP:8088访问Swagger Editor。
  3. 部署Swagger UI:

    • 拉取镜像: docker pull swaggerapi/swagger-ui:v4.15.5
    • 运行容器,将容器的8080端口映射到宿主机的8080端口:docker run -d -p 8080:8080 swaggerapi/swagger-ui:v4.15.5
    • 通过浏览器访问http://你的服务器IP:8080访问Swagger UI。

使用Cpolar实现远程访问

为了远程访问部署好的Swagger,可以使用Cpolar工具将本地端口映射到公网。

  1. 安装Cpolar: 访问Cpolar官网获取安装命令并安装Cpolar。

  2. 创建Cpolar隧道: 在Cpolar中,创建隧道将Swagger Editor和Swagger UI的端口映射到公网。 你将获得一个公网地址,用于远程访问。

  3. 固定公网地址 (可选): 为了获得稳定的公网地址,建议在Cpolar中配置二级子域名,避免地址随机变化。 参考ain/”>Cpolar固定公网地址教程。

使用apache或Nginx作为Web服务器 (传统方法)

如果你更倾向于使用传统Web服务器,Apache或nginx也是不错的选择。

  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/my-swagger
    • 在配置文件中,修改server块的root和index指令,指向Swagger UI和Swagger Editor。
    • 重启Nginx: sudo systemctl restart nginx

选择以上任一方法,即可在Linux服务器上成功部署Swagger并实现本地或远程访问。 根据实际需求选择最合适的方式。

相关阅读