ASP.NET Web Api路由自定义

Question

我有WebApi控制器,其名称后缀为"Api"后缀(例如:StudentsApiController,InstructorsApiController).我这样做是为了轻松区分我的MVC控制器和WebApi控制器.我希望我的WebApi路线看起来类似于

http://localhost:50009/api/students/5而不是http://localhost:50009/api/studentsapi/5.

目前为实现这一目标,我正在设置路线

routes.MapHttpRoute(
name: "GetStudents",
routeTemplate: "api/students/{id}",
defaults: new { controller = "StudentsApi", id = RouteParameter.Optional });

routes.MapHttpRoute(
name: "GetInstructors",
routeTemplate: "api/instructors/{id}",
defaults: new { controller = "InstructorsApi", id = RouteParameter.Optional });

由于我必须为控制器中的每个方法添加路由,因此这非常麻烦.我希望应该有一种简单的方法来设置路由模板,在处理路由时自动添加控制器名称的"api"后缀.

Answer 1

按照@Youssef Moussaoui的指示,我最终编写了以下代码来解决问题.

public class ApiControllerSelector : DefaultHttpControllerSelector
{
    public ApiControllerSelector(HttpConfiguration configuration)
        : base(configuration)
    {
    }

    public override string GetControllerName(HttpRequestMessage request)
    {
        if (request == null)
            throw new ArgumentNullException("request");

        IHttpRouteData routeData = request.GetRouteData();

        if (routeData == null)
            return null;

        // Look up controller in route data
        object controllerName;
        routeData.Values.TryGetValue("controller", out controllerName);

        if (controllerName != null)
            controllerName += "api";

        return (string)controllerName;
    }
}

并将其注册在Global.asax中

GlobalConfiguration.Configuration.Services.Replace(typeof(IHttpControllerSelector),
            new ApiControllerSelector(GlobalConfiguration.Configuration));

Answer 2

现在,ASP.NET Web API 2已经推出,通过使用属性路由,可以轻松地执行更复杂的路由,就像您建议的那样.

在控制器的顶部,只需添加以下属性:

[RoutePrefix("api/students")]
public class StudentsApiController : ApiController
{
    ...
}

然后在每个API方法之前:

[Route("{id}"]
public HttpResponseMessage Get(int id)
{
    ...
}

需要进行一些设置,但以这种方式进行路由的好处很多.首先,您可以使用执行实际工作的控制器和方法进行路由,因此您永远不会在想知道您是否拥有正确的路线.其次,更重要的是,更复杂的路由更容易,例如让控制器名称与路由名称不同(如您所愿)或具有非常复杂的模式来匹配.

Answer 3

我认为你正在寻找的可扩展性点是控制器选择器.您可以创建一个派生自DefaultHttpControllerSelector的类,并重写GetControllerName以去掉"api"部分.然后,您可以在服务的配置服务上注册此控制器选择器.