asp.net core apiversion 与swagger 结合

最新推荐文章于 2025-05-17 16:06:26 发布

静静的躺平

最新推荐文章于 2025-05-17 16:06:26 发布

阅读量379

点赞数

CC 4.0 BY-SA版权

文章标签： c# swagger2

本文链接：https://blog.youkuaiyun.com/weixin_39578505/article/details/119574260

本文介绍如何在ASP.NET Core项目中实现API版本控制，利用Apiversion库进行版本管理，并结合Swagger进行可视化接口文档展示，提供开发者友好的API探索环境。

摘要生成于 C知道，由 DeepSeek-R1 满血版支持，前往体验 >


1 需要引用我们要到的库
using Microsoft.AspNetCore.Mvc;
using Microsoft.AspNetCore.Mvc.ApiExplorer;
using Microsoft.AspNetCore.Mvc.Versioning;
using Swashbuckle.AspNetCore.SwaggerGen;

2 在我们的 configservices 中进行配置
services.AddApiVersioning(options =>
{
    options.ReportApiVersions = true;
    options.ApiVersionReader = new UrlSegmentApiVersionReader();
});
services.AddVersionedApiExplorer(options =>
{
    options.GroupNameFormat = "'v'VV";
    options.SubstituteApiVersionInUrl = true;
});
//配置
services.AddSwaggerGen(c =>
{
    
 
    var provider = services.BuildServiceProvider().GetRequiredService<IApiVersionDescriptionProvider>();
    foreach (var description in provider.ApiVersionDescriptions)
    {
        c.SwaggerDoc(
            description.GroupName,
            new OpenApiInfo
            {
                Title = "AgileTea Learning API",
                Version = description.ApiVersion.ToString()
            });
    }


});
3 继续配置  
Configure

app.UseSwagger()