路由属性在 Web API 2 中不起作用

Question

我的 API 控制器上有两个 GET 方法。当我尝试调用使用路由属性修饰的GetByCompanyId 方法时，请求被路由到GetById 方法。下面是相关的代码文件。

global.ascx.cs

public class WebApiApplication : System.Web.HttpApplication
{
    protected void Application_Start()
    {
        AreaRegistration.RegisterAllAreas();
        GlobalConfiguration.Configure(WebApiConfig.Register);
        FilterConfig.RegisterGlobalFilters(GlobalFilters.Filters);
        RouteConfig.RegisterRoutes(RouteTable.Routes);
        BundleConfig.RegisterBundles(BundleTable.Bundles);
    }
}

webApiConfig

public static class WebApiConfig
{
    public static void Register(HttpConfiguration config)
    {
        // Web API configuration and services
        // Configure Web API to use only bearer token authentication.
        config.SuppressDefaultHostAuthentication();
        config.Filters.Add(new HostAuthenticationFilter(OAuthDefaults.AuthenticationType));

        // Web API routes
        config.MapHttpAttributeRoutes();

        config.EnableCors();

        config.Formatters.JsonFormatter.SerializerSettings.ContractResolver = new CamelCasePropertyNamesContractResolver();

        config.Routes.MapHttpRoute(
            name: "DefaultApi",
            routeTemplate: "api/{controller}/{id}",
            defaults: new { id = RouteParameter.Optional }
        );

    }
}

route.config

public class RouteConfig
{
    public static void RegisterRoutes(RouteCollection routes)
    {
        routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

        routes.MapRoute(
            name: "Default",
            url: "{controller}/{action}/{id}",
            defaults: new { controller = "Home", action = "Index", id = UrlParameter.Optional }
        );
    }
}

CompanyFunctionsController.cs

public IHttpActionResult GetById(int id)
{
    var companyFunction = this._service.GetByKey(new object[] { id });

    if (companyFunction != null)
    {
        var companyFunctionDto = Mapper.Map<CompanyFunctionDto>(companyFunction);

        return Ok(companyFunctionDto);
    }

    return NotFound();
}

[Route("CompanyFunctions/GetByCompanyId", Name = "GetByCompanyId")]
[HttpGet]
public IEnumerable<CompanyFunctionDto> GetByCompanyId(int id)
{
    var collection = this._service.GetAll().ToList().Where(x => x.CompanyId == id);

    IEnumerable<CompanyFunctionDto> collectCompanyFunctionDtos = Mapper.Map<IEnumerable<CompanyFunctionDto>>(collection);

    return collectCompanyFunctionDtos;
}

我的 HTTP 请求： http://localhost:1317/api/CompanyFunctions/GetByCompanyId?id=1

Answer 1

如果你想要一个以api 开头的路由，比如http://localhost:1317/api/CompanyFunctions/GetByCompanyId?id=1，那么你必须在你希望它去的路由属性中使用字符串api。

[Route("api/CompanyFunctions/GetByCompanyId", Name = "GetByCompanyId")]

否则只会根据http动词匹配（本例为Get）。

或者，您也可以使用 [RoutePrefix("api/CompanyFunctions")] 属性装饰 Web api 控制器，并将您的 Route 属性更改为 [Route("GetByCompanyId", Name = "GetByCompanyId")]

Answer 2

Web API 2 支持一种新的路由类型，称为属性路由。顾名思义，属性路由使用属性来定义路由。属性路由让您可以更好地控制 Web API 中的 URI 您可以使用 Web Api 中的属性路由来解决您的问题。你的 Controller Action 应该是这样的，

    [Route("CompanyFunctions/GetByCompanyId/{companyId}"]
 public IEnumerable<CompanyFunctionDto> GetByCompanyId(int companyId)
 {
    var collection = this._service.GetAll().ToList().Where(x => x.CompanyId == companyId);

    IEnumerable<CompanyFunctionDto> collectCompanyFunctionDtos = Mapper.Map<IEnumerable<CompanyFunctionDto>>(collection);

    return collectCompanyFunctionDtos;
 }

你的 HTTP 请求是http://localhost:1317/CompanyFunctions/GetByCompanyId/1