.NET Core API属性路由:能否在Action约束控制器路由参数?
当然可以实现这个需求,但你当前的写法存在两个关键问题需要修正:一是路由路径重复了category参数,导致生成的路由不符合预期;二是C#本身不允许同一类中存在同名且参数列表完全一致的方法(返回类型不参与重载判定),这会直接导致编译错误。
下面是具体的解决方案:
1. 修复路由重复问题
你在Action上添加的[Route("{category:sample1}")]会和控制器的路由模板拼接,最终生成的路由会是v{version}/{category}/[controller]/{category:sample1}/{id}——这里category被重复定义了两次,显然不是你想要的结果。我们需要让每个Action直接匹配指定的category值,避免重复嵌套。
2. 解决方法重载的编译错误
因为C#不允许同名同参数的方法共存,所以你有两种选择:要么给方法起不同的名字,要么用[ActionName]属性让ASP.NET Core把它们视为不同的Action(同时保证路由唯一)。
完整示例代码
这里提供两种可行的实现方式,你可以根据自己的习惯选择:
方式一:使用绝对路由明确匹配category
这种方式直接为每个Action指定完整的路由路径,清晰对应到sample1和sample2:
[ApiController] [Route("v{version:apiVersion}/{category}/[controller]")] public class SamplesController : ControllerBase { // 匹配路由:v{version}/sample1/Samples/{id} [HttpGet("{id}")] [Route("~/v{version:apiVersion}/sample1/[controller]/{id}")] public async Task<SampleOneDto> GetSampleOneById([FromRoute] Guid id) { return new SampleOneDto(); } // 匹配路由:v{version}/sample2/Samples/{id} [HttpGet("{id}")] [Route("~/v{version:apiVersion}/sample2/[controller]/{id}")] public async Task<SampleTwoDto> GetSampleTwoById([FromRoute] Guid id) { return new SampleTwoDto(); } }
方式二:保留"GetById"的Action名称
如果你想对外暴露的Action名称都是GetById,可以用[ActionName]属性,同时给方法本身起不同的内部名称来规避编译错误:
[ApiController] [Route("v{version:apiVersion}/{category}/[controller]")] public class SamplesController : ControllerBase { // 仅匹配category为"sample1"的请求,对外名称为GetById [HttpGet("{id}")] [ActionName("GetById")] [Route("~/v{version:apiVersion}/sample1/[controller]/{id}")] public async Task<SampleOneDto> GetByIdForSample1([FromRoute] Guid id) { return new SampleOneDto(); } // 仅匹配category为"sample2"的请求,对外名称为GetById [HttpGet("{id}")] [ActionName("GetById")] [Route("~/v{version:apiVersion}/sample2/[controller]/{id}")] public async Task<SampleTwoDto> GetByIdForSample2([FromRoute] Guid id) { return new SampleTwoDto(); } }
额外提示
如果需要更灵活的category约束(比如匹配多个特定值),你还可以自定义路由约束:实现IRouteConstraint接口,然后在路由模板中使用{category:你的自定义约束名}来实现更复杂的匹配逻辑。
内容的提问来源于stack exchange,提问作者Sasaman

