.NET 6中apiVersion路由约束未注册引发异常问题求助

问题原因 #

本地运行环境未正确注册apiVersion路由约束类型，导致路由模板中的{version:apiVersion}约束无法被识别。开发环境正常可能是因为依赖包自动完成了约束注册，或环境配置存在差异。

解决方案 #

1. 确认安装必要的NuGet包
   确保项目已安装Microsoft.AspNetCore.Mvc.Versioning包（若需API文档支持，可额外安装Microsoft.AspNetCore.Mvc.Versioning.ApiExplorer）。

2. 正确配置API版本化服务
   在Program.cs中添加API版本化服务配置，确保约束自动注册：

   builder.Services.AddApiVersioning(options =>
   {
       // 可选配置：启用API版本报告、默认版本等
       options.ReportApiVersions = true;
       options.AssumeDefaultVersionWhenUnspecified = true;
       options.DefaultApiVersion = new ApiVersion(1, 0);
   });
   

   上述配置会自动将apiVersion约束注册到路由系统中。如果自动注册不生效，可手动添加约束映射：

   builder.Services.Configure<RouteOptions>(options =>
   {
       options.ConstraintMap.Add("apiVersion", typeof(Microsoft.AspNetCore.Mvc.Versioning.ApiVersionRouteConstraint));
   });
   

3. 验证控制器路由与特性配置
   确保控制器上的特性与路由模板匹配：

   [ApiVersion("1.0")]
   [Route("api/v{version:apiVersion}/product/[controller]")]
   [ApiController]
   public class SampleController : ControllerBase
   {
       // 控制器业务方法
   }
   

4. 检查环境配置差异
   对比本地与开发环境的appsettings.json及启动配置，确保没有禁用API版本化相关的配置项。

内容的提问来源于stack exchange，提问作者TrevorGoodchild