centos swagger資源推薦

在CentOS系統上安裝和配置Swagger（現稱為OpenAPI）主要涉及Java運行環境（JRE或JDK）的安裝、Maven的配置、Swagger Core和Swagger UI的構建與部署。以下是詳細的步驟和技巧：

安裝Java環境

Swagger需要Java運行環境（JRE）或Java開發工具包（JDK）。你可以通過以下命令安裝OpenJDK：

sudo yum update
sudo yum install openjdk-11-jdk
java -version

安裝Maven

Swagger使用Maven進行構建和依賴管理。你可以通過以下命令安裝Maven：

sudo yum install maven
mvn -version

安裝Swagger Core和Swagger UI

你可以從Swagger的官方GitHub倉庫克隆Swagger Core和Swagger UI項目：

git clone https://github.com/swagger-api/swagger-core.git
cd swagger-core
mvn clean install

git clone https://github.com/swagger-api/swagger-ui.git
cd swagger-ui
mvn clean install

配置和部署Swagger UI

1. 構建Swagger UI：

cd swagger-ui
mvn clean install

2. 部署Swagger UI：

將構建好的Swagger UI文件復制到你的Web服務器目錄中，例如 /var/www/html。你可以使用以下命令將文件復制到該目錄：

sudo cp -r target/swagger-ui-dist/* /var/www/html/

3. 配置Web服務器：

• 使用Apache：

sudo cp /etc/apache2/sites-available/000-default.conf /etc/apache2/sites-available/swagger.conf
sudo a2ensite swagger.conf
sudo systemctl reload apache2

• 使用Nginx：

sudo cp /etc/nginx/sites-available/default /etc/nginx/sites-available/swagger
sudo ln -s /etc/nginx/sites-available/swagger /etc/nginx/sites-enabled/
sudo nginx -t
sudo systemctl reload nginx

4. 訪問Swagger UI：

打開瀏覽器，訪問 http://localhost，你應該能夠看到Swagger UI的歡迎頁面。

調試技巧

• 接口版本控制：使用 [ApiVersion] 特性區分不同版本的API響應。
• 添加返回示例：通過 [SwaggerResponse] 添加返回示例。
• 請求示例：用 [SwaggerRequestExample] 展示請求參數示例。
• 中文亂碼：設置XML文檔編碼：

services.AddSwaggerGen(c =>
{
    c.SwaggerDoc("v1", new OpenApiInfo { Title = "我的API", Version = "v1" });
    c.DocumentFilter(new SwaggerDocumentFilter { DocumentFilterSwaggerDocumentFilter = true });
});

• 隱藏某些接口：使用 [ApiExplorerSettings(IgnoreApi = true)]。