温馨提示×

如何在Linux上使用Swagger UI进行调试

小樊
74
2025-04-19 05:00:08
栏目: 智能运维

在Linux上使用Swagger UI进行调试,可以按照以下步骤进行:

安装Swagger UI和Swagger Editor

  1. 安装Java环境:Swagger UI通常需要Java运行环境,因此首先需要在你的Linux服务器上安装Java。
sudo apt update
sudo apt install openjdk-11-jdk
  1. 下载并解压Swagger UI
wget https://github.com/swagger-api/swagger-ui/archive/refs/tags/v3.50.0.tar.gz
tar -xvf swagger-ui-3.50.0.tar.gz
  1. 配置Swagger UI
  • 编辑 index.html 文件,找到以下行并进行修改:
script window.onload function () {
  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"
  });
  window.ui = ui;
};
  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.backupsudo nano /etc/nginx/sites-available/default

修改 server 块中的 rootindex 指令:

server {
  listen 80 default_server;
  listen [::]: 80 default_server;
  root /usr/local/nodejs;
  index index.html index.htm;
  server_name _;
  location / {
    try_files uri uri /index.html;
  }
}

保存并退出编辑器,然后重启Nginx:

sudo systemctl restart nginx
  1. 访问Swagger UI:打开浏览器,访问 http://your_server_ip:8080 即可使用Swagger UI。

调试技巧

  • 自定义JavaScript脚本:在Swagger UI的 wwwroot/swagger-ui/ 目录下创建一个 custom.js 文件。在这个文件中,您可以编写自定义函数(例如 authorizeSwagger),用于在获取token后自动授权Swagger。
  • 静态文件服务:确保您的应用正确地启用了静态文件服务,以便Swagger UI能够正常加载所有必要的文件。
  • JavaScript注入:使用InjectJavascript机制将您的 custom.js 脚本注入到Swagger UI中间件中,实现自动授权等功能。

通过以上步骤,你就可以在Linux系统上成功部署和使用Swagger进行API测试和调试了。

0