如何在Linux中使用Swagger進行API調試

在Linux中使用Swagger進行API調試，可以按照以下步驟進行：

安裝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 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;
};

4. 啟動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.baks
sudo nano /etc/nginx/sites-available/default

修改 server 塊中的 root 和 index 指令：

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 / /index.html;
  }
}

保存并退出編輯器，然后重啟Nginx：

sudo systemctl restart nginx

5. 安裝并啟動Swagger Editor：

npm install -g swagger-editor
swagger editor http://localhost:9000

使用Swagger進行API調試

1. 添加API調試和測試工具： 確保你已經安裝了Swagger。如果還沒有安裝，可以使用以下命令進行安裝：

npm install -g swagger

2. 創建并配置 swagger.json 文件： 在你的項目中創建一個名為 swagger.json 的文件，用于描述你的API接口。

3. 生成API文檔頁面： 使用Swagger CLI生成API文檔頁面：

swagger project start my-api --host localhost --port 8080 --schemes http

4. 啟動Swagger UI服務器： 打開瀏覽器，訪問 http://localhost:8080，你將看到Swagger UI界面，其中包含了你的API接口信息。在這里，你可以進行API的調試和測試。

通過以上步驟，你可以在Linux上成功安裝和配置Swagger，從而進行API調試。