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)]。