這裡將如何教你幫.NET Core Web API快速加上版本號來做版本控制
首先我們先下載相關套件
Microsoft.AspNetCore.Mvc.Versioning
然後在Startup.cs加入下列程式
services.AddApiVersioning(options =>
{
// 是否使用預設版本
options.AssumeDefaultVersionWhenUnspecified = true;
// 在Header顯示該Api版本
options.ReportApiVersions = true;
// API預設版本
options.DefaultApiVersion = new ApiVersion(1, 0);
});
然後在Controller的Attribute上加入
[Route("v{apiVersion}/[controller]")
讓Router的路徑預設需要加入apiVersion
接著在呼叫的時候API時加入版號就可以得到相對應資訊了
以下為Example Controller
[ApiController]
[Route("v{apiVersion}/[controller]")]
public class DemoController : Controller
{
/// <summary>
/// 取得目前API版本
/// </summary>
/// <returns></returns>
[HttpGet]
public IActionResult Version()
{
var returnData = new ReturnData
returnData.Code = SystemCode.STATUS_OK;
// 取得預設ApiVersion版本
returnData.Data = ApiVersion.Default;
return Json(returnData);
}
}
執行結果