溫馨提示×

如何在Linux上使用Swagger UI進行調試

小樊
69
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
亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女