溫馨提示×

Linux環境下Swagger怎么調試

小樊
41
2025-06-24 22:02:32
欄目: 智能運維

在Linux環境下使用Swagger進行調試,可以按照以下步驟進行:

安裝Swagger UI和Swagger Editor

  1. 安裝Node.js和npm

    sudo apt update
    sudo apt install -y nodejs npm
    
  2. 下載并安裝Swagger UI

    wget https://repo1.maven.org/maven2/io/springfox/springfox-swagger-ui/2.9.2/springfox-swagger-ui-2.9.2.html
    unzip springfox-swagger-ui-2.9.2.html
    sudo mv springfox-swagger-ui-2.9.2 /var/www/html/swagger-ui
    
  3. 安裝Swagger Editor

    npm install -g swagger-editor
    
  4. 啟動Swagger Editor

    swagger editor http://localhost:9000
    

配置Swagger UI

  1. 編輯index.html文件: 找到以下行并進行修改:

    script src="swagger-editor.js" type="text/javascript"></script>
    window.onload = function() {
      const editor = SwaggerEditor({
        url: "http://your-api-docs-url"
      });
    };
    
  2. 啟動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.backups
      sudo 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
      

訪問和調試Swagger UI

  1. 訪問Swagger UI: 在瀏覽器中訪問Swagger UI的URL(例如http://localhost:38081/swagger-ui.html),你將能夠看到Swagger UI的界面,列出所有可用的API接口及其文檔。

  2. 測試API接口: 通過點擊“TRY IT OUT”按鈕測試API接口,驗證它們是否按預期工作。

使用IDE進行調試(可選)

  1. 配置IDE: 在IDE(如IntelliJ IDEA或Visual Studio Code)中配置遠程調試,連接到運行Swagger UI的容器。

  2. 設置斷點: 在IDE中設置斷點,然后啟動調試會話。

  3. 調試運行: 通過調試運行Swagger UI,可以在代碼執行到斷點時進行調試。

通過以上步驟,你可以在Linux系統上成功部署和調試Swagger,從而進行API調試。如果需要更詳細的配置步驟或遇到特定問題,可以參考相關的官方文檔或教程。

0
亚洲午夜精品一区二区_中文无码日韩欧免_久久香蕉精品视频_欧美主播一区二区三区美女