对于asp.net core 3.0,您可以按照以下步骤操作:
1.安装Swashbuckle.AspNetCore 5.0.0 https://www.nuget.org/packages/Swashbuckle.AspNetCore/
2.安装Microsoft.AspNetCore.Mvc.Versioning 4.0.0 https://www.nuget.org/packages/Microsoft.AspNetCore.Mvc.Versioning/4.0.0
3.安装Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer 4.0.0 https://www.nuget.org/packages/Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer/4.0.0
4.如下更改您的控制器(ApiVersion
需要在控制器上声明):
[Route("api/v{version:apiVersion}/[controller]")]
[ApiVersion("1.0")]
public class TestController : MyApiControllerBase
{
[HttpGet]
public IActionResult Get()
{
return Ok("Version 1.0 endpoint.");
}
}
[Route("api/v{version:apiVersion}/[controller]")]
[ApiVersion("2.0")]
public class TestController : MyApiControllerBase
{
[HttpGet]
public IActionResult Get()
{
return Ok("Version 2.0 endpoint.");
}
}
5.Startup.cs(注意需要使用services.AddVersionedApiExplorer
并设置options.SubstituteApiVersionInUrl=true
告诉 swagger 替换控制器路由中的版本并配置 api 版本:):
public void ConfigureServices(IServiceCollection services)
{
services.AddControllers();
services.AddApiVersioning(o => {
o.ReportApiVersions = true;
o.AssumeDefaultVersionWhenUnspecified = true;
o.DefaultApiVersion = new ApiVersion(1, 0);
});
services.AddVersionedApiExplorer(o =>
{
o.GroupNameFormat = "'v'VVV";
o.SubstituteApiVersionInUrl = true;
});
services.AddSwaggerGen(options =>
{
options.DocInclusionPredicate((docName, apiDesc) =>
{
if (!apiDesc.TryGetMethodInfo(out MethodInfo methodInfo))
{
return false;
}
IEnumerable<ApiVersion> versions = methodInfo.DeclaringType
.GetCustomAttributes(true)
.OfType<ApiVersionAttribute>()
.SelectMany(a => a.Versions);
return versions.Any(v => $"v{v.ToString()}" == docName);
});
options.SwaggerDoc("v1.0", new OpenApiInfo { Title = "My API", Version = "v1.0" });
options.SwaggerDoc("v2.0", new OpenApiInfo { Title = "My API", Version = "v2.0" });
});
}
// This method gets called by the runtime. Use this method to configure the HTTP request pipeline.
public void Configure(IApplicationBuilder app, IWebHostEnvironment env)
{
if (env.IsDevelopment())
{
app.UseDeveloperExceptionPage();
}
app.UseHttpsRedirection();
app.UseApiVersioning();
app.UseSwagger();
app.UseSwaggerUI(c =>
{
c.SwaggerEndpoint("/swagger/v1.0/swagger.json", "V1 Docs");
c.SwaggerEndpoint("/swagger/v2.0/swagger.json", "V2 Docs");
});
app.UseRouting();
app.UseAuthorization();
app.UseEndpoints(endpoints =>
{
endpoints.MapControllers();
});
}