信息发布→ 登录 注册 退出

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

发布时间:2025-03-10

点击量:

本文介绍如何在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配置

  1. 创建API版本枚举: 创建一个ApiVersions.cs文件,定义您的API版本:
public enum ApiVersions
{
    V1,
    V2,
    V3
}
  1. 配置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}" });
    }
});
  1. 启用XML注释 (可选但推荐): 在您的.csproj文件中,启用XML文档文件的生成:

  true

然后在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文档:

  • 版本1: http://your-server-ip:port/swagger/V1/swagger.json
  • 版本2: http://your-server-ip:port:port/swagger/V2/swagger.json
  • 版本3: http://your-server-ip:port/swagger/V3/swagger.json

(请将your-server-ipport替换为您的服务器IP地址和端口号。)

通过以上步骤,您可以在Linux环境下成功实现Swagger API的版本控制,并为每个版本生成独立的文档。 请注意,代码示例基于.NET框架,其他框架可能需要调整代码以适应其环境。

标签:# debian  # 请将  # 管理器  # 为例  # 可选  # 可以使用  # 请注意  # 所需  # 您可以  # 文档  # 您的  # linux  # ui  # ubuntu  # http  # JS  # xml  # express  # npm  # json  # nodejs  
在线客服
服务热线

服务热线

4008888355

微信咨询
二维码
返回顶部
×二维码

截屏,微信识别二维码

打开微信

微信号已复制,请打开微信添加咨询详情!