ASP.NET通用WebHooks无法配置非api/前缀的自定义路由URI

根本原因 #

这不是Bug，你没有遗漏普通路由配置，问题在于ASP.NET通用WebHooks的路由注册逻辑独立于普通Web API路由，默认会内置注册api/webhooks/incoming/*前缀的专属路由，你手动添加的普通HttpRoute不会被WebHook接收器识别，而且WebHook请求默认由专属的WebHookReceiversController处理，普通路由没有绑定到该控制器的规则，自然无法响应。

解决方案 #

有两种可行的配置方法：

方法1：修改WebHook全局路由前缀（推荐） #

在注册WebHook接收器时，直接使用InitializeReceiveWebHooks方法的重载传入自定义前缀，示例代码如下：

// 注册WebHook时指定自定义前缀，替换默认的api/前缀
config.InitializeReceiveWebHooks("portalapi/v1/webhooks/incoming");

// 再注册你原本的普通PortalApi路由，注意必须放在WebHook注册之后
config.Routes.MapHttpRoute(
    name: "PortalApi",
    routeTemplate: "portalapi/v1/{controller}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

注意：路由注册顺序不能颠倒，WebHook路由优先级必须高于普通API路由，否则普通路由会优先匹配WebHook请求，导致404。

方法2：手动映射WebHook专属路由 #

如果你不需要修改全局WebHook前缀，也可以手动添加绑定到WebHook控制器的路由规则：

// 手动注册WebHook专属路由
config.Routes.MapHttpRoute(
    name: "CustomWebHookRoute",
    routeTemplate: "portalapi/v1/webhooks/incoming/{receiver}/{id}",
    defaults: new { controller = "WebHookReceivers", id = RouteParameter.Optional },
    constraints: new { httpMethod = new HttpMethodConstraint(HttpMethod.Post) }
);

// 再注册普通PortalApi路由
config.Routes.MapHttpRoute(
    name: "PortalApi",
    routeTemplate: "portalapi/v1/{controller}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

验证 #

配置完成后，WebHook接收器就可以响应路径为/portalapi/v1/webhooks/incoming/[接收器名称]的POST请求，和默认api/*路径的响应逻辑完全一致。

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