Swagger在Linux下如何进行版本控制-LINUX-PHP中文网

Swagger在Linux下如何进行版本控制

畫卷琴夢

发布： 2025-03-10 14:48:11

原创

1058人浏览过

swagger在linux下如何进行版本控制

本文介绍如何在Linux环境下实现Swagger API的版本控制。以下步骤将指导您完成配置：

一、准备工作：安装必要组件

首先，确保您的Linux系统已安装Node.js和npm包管理器。可以使用以下命令进行安装（以Debian/Ubuntu为例，其他发行版请参考对应指令）：

curl -sL https://deb.nodesource.com/setup_14.x | sudo -E bash -
sudo apt-get install -y nodejs

登录后复制

然后，安装Swagger所需的Express框架和其他依赖包：

sudo npm install express body-parser cookie-parser multer --save

登录后复制

二、定义API版本和Swagger配置

创建API版本枚举: 创建一个ApiVersions.cs文件，定义您的API版本：

public enum ApiVersions
{
    V1,
    V2,
    V3
}

登录后复制

配置SwaggerGen: 在您的Program.cs (或等效的启动文件)中，使用SwaggerGen配置生成不同版本的Swagger文档：

builder.Services.AddSwaggerGen(options =>
{
    foreach (var version in Enum.GetNames(typeof(ApiVersions)))
    {
        options.SwaggerDoc(version, new OpenApiInfo { Title = $"API Version {version}", Version = version, Description = $"This is API version {version}" });
    }
});

登录后复制

启用XML注释 (可选但推荐): 在您的.csproj文件中，启用XML文档文件的生成：

<PropertyGroup>
  <GenerateDocumentationFile>true</GenerateDocumentationFile>
</PropertyGroup>

登录后复制

然后在Program.cs中加载XML注释文件：

var xmlFile = Path.Combine(AppContext.BaseDirectory, $"{Assembly.GetExecutingAssembly().GetName().Name}.xml");
options.IncludeXmlComments(xmlFile, true);

登录后复制

三、配置Swagger UI

在您的Program.cs (或等效的启动文件)中，配置Swagger UI以显示不同版本的API文档：

app.UseSwaggerUI(options =>
{
    foreach (var version in Enum.GetNames(typeof(ApiVersions)))
    {
        options.SwaggerEndpoint($"/swagger/{version}/swagger.json", $"Version {version}");
    }
});

登录后复制

四、部署和访问

部署您的应用程序后，您可以通过以下URL访问不同版本的Swagger文档：