溫馨提示×

Linux上Swagger工具鏈有哪些推薦

小樊
48
2025-03-26 03:28:55
欄目: 智能運維

在Linux系統上,Swagger工具鏈主要包括Swagger UI和Swagger Editor。以下是推薦的安裝和使用方法:

安裝Swagger UI

  1. 更新包列表
sudo apt update
  1. 安裝必要的依賴
sudo apt install -y openjdk-11-jre-headless
  1. 下載并解壓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
  1. 移動解壓后的文件到Web服務目錄(例如 /var/www/html):
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: "http://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;
};
  1. 啟動Web服務器(例如Apache或Nginx):
  • Apache
sudo a2ensite default.confsudo systemctl restart apache2
  • Nginx
sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.baksudo 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/ =404;
  }
}

保存并退出編輯器,然后重啟Nginx:

sudo systemctl restart nginx

安裝Swagger Editor

  1. 下載Swagger Editor
wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.js
wget https://cdnjs.cloudflare.com/ajax/libs/swagger-ui/3.50.0/swagger-editor.min.css
  1. 移動文件到Web服務目錄(例如 /var/www/html):
sudo mv swagger-editor.min.js /var/www/html/swagger-editor.js
sudo mv swagger-editor.min.css /var/www/html/swagger-editor.css
  1. 創建一個簡單的HTML文件來加載Swagger Editor
sudo nano /var/www/html/swagger-editor.html

添加以下內容:

!DOCTYPE html>
html
head
  link rel "stylesheet" type "text/css" href "swagger-editor.css"
/head
body
  div id "swagger-editor">
/div
script src "swagger-editor.js"
/script
script window.onload function () {
  const editor = SwaggerEditor({
    url: "https://petstore.swagger.io/v2/api-docs",
    dom_id: '#swagger-editor'
  });
};
/script
/body
/html
  1. 啟動Web服務器(例如Apache或Nginx):
  • Apache
sudo a2ensite default.confsudo systemctl restart apache2
  • Nginx
sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/default.baksudo 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/ =404;
  }
}

保存并退出編輯器,然后重啟Nginx:

sudo systemctl restart nginx

現在,你應該能夠通過瀏覽器訪問 http://your_server_ip/swagger-uihttp://your_server_ip/swagger-editor 來查看和使用Swagger UI和Swagger Editor。

請注意,以上信息僅供參考,具體配置步驟可能因你的Linux發行版和Swagger集成方式的不同而有所變化。在生產環境中部署Swagger之前,請確保進行充分的測試,并根據你的具體環境進行相應的配置。

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