带有两个GET动作的WebApi控制器

本文关键字：WebApi 控制器 GET 两个 | 更新日期: 2023-09-27 18:06:22

我想有两个不同的GET操作来查询数据，名称和id，

我有这些路线:

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

和控制器中的这些动作:

    [HttpGet]
    public CompanyModel CompanyId(Guid id)
    {
          //Do something
    }

    [HttpGet]
    public CompanyModel CompanyName(string name)
    {
            //Do something
    }

而像这样的调用:http://localhost:51119/api/companies/CompanyId/3cd97fbc-524e-47cd-836c-d709e94c5e1e工作并获得'CompanyId'方法，

对http://localhost:51119/api/companies/CompanyName/something的类似调用使我无法找到404

但这:' http://localhost:51119/api/companies/CompanyName/?name=something '工作正常

谁能解释一下这种行为，我做错了什么?

带有两个GET动作的WebApi控制器

Web API路由选择器无法知道URL末尾的字符串是否是GUID。因此，不需要为适当的GET操作选择正确的路由。

为了选择正确的路由，您需要为GUID uri模板添加路由约束。

    public class GuidConstraint : IHttpRouteConstraint
    {
        public bool Match(HttpRequestMessage request, IHttpRoute route, string parameterName, IDictionary<string, object> values,
                          HttpRouteDirection routeDirection)
        {
            if (values.ContainsKey(parameterName))
            {
                string stringValue = values[parameterName] as string;
                if (!string.IsNullOrEmpty(stringValue))
                {
                    Guid guidValue;
                    return Guid.TryParse(stringValue, out guidValue) && (guidValue != Guid.Empty);
                }
            }
            return false;
        }
    }

然后，将约束添加到处理GUID的路由中。

config.Routes.MapHttpRoute(
            name: "ActionApi",
            routeTemplate: "api/{controller}/{action}/{id}",
            defaults: new { id = RouteParameter.Optional },
            constraints: new { id = new GuidConstraint() }  // Added
        );

由于此路由比一般的"字符串"路由更具体，因此需要将其放在要解析name的路由之上。

这应该适当地路由到动作。

相关文章：