温馨提示×

Ubuntu Swagger安装步骤是什么

小樊
79
2025-03-16 06:52:40
栏目: 智能运维

在Ubuntu上安装Swagger,通常是指安装Swagger UI和Swagger Editor。以下是详细的安装步骤:

安装Swagger Editor

  1. 安装Node.js和npm
  1. 下载并解压Swagger Editor
  • 打开终端,进入你希望存放Swagger Editor的目录,例如/opt/swagger
  • 下载Swagger Editor的最新版本:
wget https://github.com/swagger-api/swagger-editor/archive/refs/tags/v3.50.0.tar.gz
  • 解压下载的文件:
tar -xvf v3.50.0.tar.gz
  • 删除压缩文件:
rm v3.50.0.tar.gz
  1. 配置全局路径(可选):
  • 如果你在安装Node.js时没有配置全局路径,可以手动添加:
vi ~/.bashrc
  • 在文件末尾添加以下行:
export PATH=$PATH:/opt/swagger/swagger-editor-3.50.0/bin
  • 使更改立即生效:
source ~/.bashrc
  1. 启动Swagger Editor
  • 在Swagger Editor目录下,运行以下命令启动服务:
http-server
  • 默认情况下,Swagger Editor可以通过http://127.0.0.1:8080访问。

安装Swagger UI

  1. 下载Swagger UI
  • 打开终端,进入你希望存放Swagger UI的目录,例如/opt/swagger
  • 下载Swagger UI的最新版本:
wget https://repo1.maven.org/maven2/io/springfox/springfox-swagger-ui/2.9.2/springfox-swagger-ui-2.9.2.html

注意:上述链接是一个示例,你需要访问Swagger UI的官方GitHub仓库下载最新版本。

  1. 解压Swagger UI
unzip springfox-swagger-ui-2.9.2.html
  1. 移动解压后的文件到Web服务目录
sudo mv springfox-swagger-ui-2.9.2 /var/www/html/swagger-ui
  1. 配置Swagger UI
  • 编辑/var/www/html/swagger-ui/index.html文件,找到以下行并进行修改:
<script>
  window.onload = function() {
    // Begin Swagger UI call region
    const ui = SwaggerUIBundle({
      url: "https://petstore.swagger.io/v2/api-docs",
      dom_id: '#swagger-ui',
      deepLinking: true,
      presets: [
        SwaggerUIBundle.presets.apis,
        SwaggerUIStandalonePreset
      ],
      plugins: [
        SwaggerUIBundle.plugins.DownloadUrl
      ],
      layout: "StandaloneLayout"
    });
    // End Swagger UI call region
    window.ui = ui;
  };
</script>
  1. 启动Web服务器(例如Apache或Nginx):
  • 使用Apache
sudo a2ensite default.conf
sudo systemctl restart apache2
  • 使用Nginx
sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.backup
sudo nano /etc/nginx/sites-available/default
  • 修改server块中的rootindex指令:
server {
  listen 80 default_server;
  listen [::]: 80 default_server;
  root /var/www/html;
  index index.html index.htm;
  server_name _;
  location / {
    try_files $uri $uri/ /swagger-ui/;
  }
}
  • 保存并退出编辑器,然后重启Nginx:
sudo systemctl restart nginx
  1. 访问Swagger UI
  • 现在,你应该能够通过浏览器访问http://your_server_ip/swagger-ui来查看和使用Swagger UI。

请注意,上述步骤中的链接和文件名可能需要根据实际下载的最新版本进行调整。务必参考官方文档或GitHub仓库以获取最新信息。

0