ASP.NET Web API中具有多个GET方法的单个控制器

在Web API中，我有一类类似的结构：

public class SomeController : ApiController
{
    [WebGet(UriTemplate = "{itemSource}/Items")]
    public SomeValue GetItems(CustomParam parameter) { ... }

    [WebGet(UriTemplate = "{itemSource}/Items/{parent}")]
    public SomeValue GetChildItems(CustomParam parameter, SomeObject parent) { ... }
}

由于我们可以映射各个方法，因此在正确的位置获得正确的请求非常简单。对于只有一个GET方法但也有一个Object参数的类似类，我成功使用IActionValueBinder。但是，在上述情况下，出现以下错误：

Multiple actions were found that match the request: 

SomeValue GetItems(CustomParam parameter) on type SomeType

SomeValue GetChildItems(CustomParam parameter, SomeObject parent) on type SomeType

我正在尝试通过覆盖ExecuteAsync方法来解决此问题，ApiController但到目前为止还没有运气。关于这个问题有什么建议吗？

编辑：我忘了提一下，现在我正在尝试在ASP.NET Web API上移动此代码，而ASP.NET Web API具有不同的路由方法。问题是，如何使代码在ASP.NET Web API上工作？

这是我发现支持额外的GET方法以及支持常规REST方法的最佳方法。将以下路由添加到WebApiConfig：

routes.MapHttpRoute("DefaultApiWithId", "Api/{controller}/{id}", new { id = RouteParameter.Optional }, new { id = @"\d+" });
routes.MapHttpRoute("DefaultApiWithAction", "Api/{controller}/{action}");
routes.MapHttpRoute("DefaultApiGet", "Api/{controller}", new { action = "Get" }, new { httpMethod = new HttpMethodConstraint(HttpMethod.Get) });
routes.MapHttpRoute("DefaultApiPost", "Api/{controller}", new {action = "Post"}, new {httpMethod = new HttpMethodConstraint(HttpMethod.Post)});

我通过下面的测试类验证了此解决方案。我能够在下面的控制器中成功命中每种方法：

public class TestController : ApiController
{
    public string Get()
    {
        return string.Empty;
    }

    public string Get(int id)
    {
        return string.Empty;
    }

    public string GetAll()
    {
        return string.Empty;
    }

    public void Post([FromBody]string value)
    {
    }

    public void Put(int id, [FromBody]string value)
    {
    }

    public void Delete(int id)
    {
    }
}

我确认它支持以下请求：

GET /Test
GET /Test/1
GET /Test/GetAll
POST /Test
PUT /Test/1
DELETE /Test/1

注意，如果多余的GET操作不是以“ Get”开头，则可能需要向该方法添加HttpGet属性。

从此：

config.Routes.MapHttpRoute("API Default", "api/{controller}/{id}",
            new { id = RouteParameter.Optional });

对此：

config.Routes.MapHttpRoute("API Default", "api/{controller}/{action}/{id}",
            new { id = RouteParameter.Optional });

因此，您现在可以指定要将HTTP请求发送到的操作（方法）。

发布到“ http：// localhost：8383 / api / Command / PostCreateUser”会调用：

public bool PostCreateUser(CreateUserCommand command)
{
    //* ... *//
    return true;
}

并发布到“ http：// localhost：8383 / api / Command / PostMakeBooking”会调用：

public bool PostMakeBooking(MakeBookingCommand command)
{
    //* ... *//
    return true;
}

我在一个自托管的WEB API服务应用程序中尝试了此方法，它的工作原理很像:)

与通过代码手动添加属性相比，我发现使用属性更干净。这是一个简单的例子。

[RoutePrefix("api/example")]
public class ExampleController : ApiController
{
    [HttpGet]
    [Route("get1/{param1}")] //   /api/example/get1/1?param2=4
    public IHttpActionResult Get(int param1, int param2)
    {
        Object example = null;
        return Ok(example);
    }

}

您还需要在webapiconfig中使用它

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

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

一些良好的链接 http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/tutorial-your-first-web-api 这一个可以更好地说明路由。 http://www.asp.net/web-api/overview/web-api-routing-and-actions/routing-in-aspnet-web-api

您需要像这样在global.asax.cs中定义其他路由：

routes.MapHttpRoute(
    name: "Api with action",
    routeTemplate: "api/{controller}/{action}/{id}",
    defaults: new { id = RouteParameter.Optional }
);

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

使用更新的Web Api 2，拥有多个get方法变得更加容易。

如果传递给GET方法的参数足够不同，以使属性路由系统能够像ints和Guids 一样区分其类型，则可以在[Route...]属性中指定期望的类型

例如 -

[RoutePrefix("api/values")]
public class ValuesController : ApiController
{

    // GET api/values/7
    [Route("{id:int}")]
    public string Get(int id)
    {
       return $"You entered an int - {id}";
    }

    // GET api/values/AAC1FB7B-978B-4C39-A90D-271A031BFE5D
    [Route("{id:Guid}")]
    public string Get(Guid id)
    {
       return $"You entered a GUID - {id}";
    }
} 

有关此方法的更多详细信息，请参见此处http://nodogmablog.bryanhogan.net/2017/02/web-api-2-controller-with-multiple-get-methods-part-2/

另一种选择是为GET方法提供不同的路线。

    [RoutePrefix("api/values")]
    public class ValuesController : ApiController
    {
        public string Get()
        {
            return "simple get";
        }

        [Route("geta")]
        public string GetA()
        {
            return "A";
        }

        [Route("getb")]
        public string GetB()
        {
            return "B";
        }
   }

详情请参阅这里-http://nodogmablog.bryanhogan.net/2016/10/web-api-2-controller-with-multiple-get-methods/

在ASP.NET Core 2.0中，可以将Route属性添加到控制器：

[Route("api/[controller]/[action]")]
public class SomeController : Controller
{
    public SomeValue GetItems(CustomParam parameter) { ... }

    public SomeValue GetChildItems(CustomParam parameter, SomeObject parent) { ... }
}

我试图使用Web Api 2属性路由来允许多个Get方法，并且我并入了先前答案中的有用建议，但是在Controller中，我仅修饰了“特殊”方法（示例）：

[Route( "special/{id}" )]
public IHttpActionResult GetSomethingSpecial( string id ) {

...也没有在控制器的顶部放置[RoutePrefix]：

[RoutePrefix("api/values")]
public class ValuesController : ApiController

我收到错误消息，指出找不到与提交的URI匹配的Route。当我同时使用[Route]装饰该方法和[RoutePrefix]装饰整个Controller时，它就起作用了。

我不确定您是否找到了答案，但是我做到了，而且有效

public IEnumerable<string> Get()
{
    return new string[] { "value1", "value2" };
}

// GET /api/values/5
public string Get(int id)
{
    return "value";
}

// GET /api/values/5
[HttpGet]
public string GetByFamily()
{
    return "Family value";
}

现在在global.asx中

routes.IgnoreRoute("{resource}.axd/{*pathInfo}");

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

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

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

您是否尝试过切换到WebInvokeAttribute并将“方法”设置为“ GET”？

我相信我有一个类似的问题，并转而明确地告诉我，即使不是全部，大多数方法也应该使用哪种方法（GET / PUT / POST / DELETE）。

public class SomeController : ApiController
{
    [WebInvoke(UriTemplate = "{itemSource}/Items"), Method="GET"]
    public SomeValue GetItems(CustomParam parameter) { ... }

    [WebInvoke(UriTemplate = "{itemSource}/Items/{parent}", Method = "GET")]
    public SomeValue GetChildItems(CustomParam parameter, SomeObject parent) { ... }
}

WebGet 应该处理它，但是我已经看到它在使用多个Get少一些具有相同返回类型的多个Get方面存在一些问题。

[编辑：在WCF WebAPI的日落以及MVC堆栈上向ASP.Net WebAPI的迁移中，所有这些都不有效]

**Add Route function to direct the routine what you want**
    public class SomeController : ApiController
    {
        [HttpGet()]
        [Route("GetItems")]
        public SomeValue GetItems(CustomParam parameter) { ... }

        [HttpGet()]
        [Route("GetChildItems")]
        public SomeValue GetChildItems(CustomParam parameter, SomeObject parent) { ... }
    }

懒惰/匆忙的替代方案（Dotnet Core 2.2）：

[HttpGet("method1-{item}")]
public string Method1(var item) { 
return "hello" + item;}

[HttpGet("method2-{item}")]
public string Method2(var item) { 
return "world" + item;}

打电话给他们：

本地主机：5000 / api / controllername / method1-42

“ hello42”

本地主机：5000 / api / controllername / method2-99

“ world99”

以上示例均无法满足我的个人需求。以下是我最终要做的事情。

 public class ContainsConstraint : IHttpRouteConstraint
{       
    public string[] array { get; set; }
    public bool match { get; set; }

    /// <summary>
    /// Check if param contains any of values listed in array.
    /// </summary>
    /// <param name="param">The param to test.</param>
    /// <param name="array">The items to compare against.</param>
    /// <param name="match">Whether we are matching or NOT matching.</param>
    public ContainsConstraint(string[] array, bool match)
    {

        this.array = array;
        this.match = match;
    }

    public bool Match(System.Net.Http.HttpRequestMessage request, IHttpRoute route, string parameterName, IDictionary<string, object> values, HttpRouteDirection routeDirection)
    {
        if (values == null) // shouldn't ever hit this.                   
            return true;

        if (!values.ContainsKey(parameterName)) // make sure the parameter is there.
            return true;

        if (string.IsNullOrEmpty(values[parameterName].ToString())) // if the param key is empty in this case "action" add the method so it doesn't hit other methods like "GetStatus"
            values[parameterName] = request.Method.ToString();

        bool contains = array.Contains(values[parameterName]); // this is an extension but all we are doing here is check if string array contains value you can create exten like this or use LINQ or whatever u like.

        if (contains == match) // checking if we want it to match or we don't want it to match
            return true;
        return false;             

    }

要在路线中使用以上内容，请使用：

config.Routes.MapHttpRoute("Default", "{controller}/{action}/{id}", new { action = RouteParameter.Optional, id = RouteParameter.Optional}, new { action = new ContainsConstraint( new string[] { "GET", "PUT", "DELETE", "POST" }, true) });

发生的是方法中的约束种类伪造品，因此此路由将仅与默认的GET，POST，PUT和DELETE方法匹配。此处的“ true”表示我们要检查数组中各项的匹配情况。如果为假，则表示要排除str中的那些。然后，您可以在此默认方法之上使用路由，例如：

config.Routes.MapHttpRoute("GetStatus", "{controller}/status/{status}", new { action = "GetStatus" });

在上面，它实际上是在寻找以下URL => http://www.domain.com/Account/Status/Active或类似的东西。

除了以上所述，我不确定我会变得太疯狂了。在一天结束时，应该针对每个资源。但是我确实出于各种原因需要映射友好的URL。随着Web Api的发展，我可以肯定会有一些规定。如果有时间的话，我将建立一个更永久的解决方案并发布。

上面的任何路由解决方案都无法正常工作-有些语法似乎已经更改，并且我仍然对MVC还是陌生的-尽管我整理了一下这个非常糟糕（简单）的技巧，但我仍会感到困惑到目前为止，请注意，这将替换“ public MyObject GetMyObjects（long id）”方法-我们将“ id”的类型更改为字符串，并将返回类型更改为object。

// GET api/MyObjects/5
// GET api/MyObjects/function
public object GetMyObjects(string id)
{
    id = (id ?? "").Trim();

    // Check to see if "id" is equal to a "command" we support
    // and return alternate data.

    if (string.Equals(id, "count", StringComparison.OrdinalIgnoreCase))
    {
        return db.MyObjects.LongCount();
    }

    // We now return you back to your regularly scheduled
    // web service handler (more or less)

    var myObject = db.MyObjects.Find(long.Parse(id));
    if (myObject == null)
    {
        throw new HttpResponseException
        (
            Request.CreateResponse(HttpStatusCode.NotFound)
        );
    }

    return myObject;
}

如果您在同一文件中有多个动作，则将相同的参数（例如，Id）传递给所有动作。这是因为操作只能识别Id，所以不能给参数指定任何名称，而只能这样声明Id。

[httpget]
[ActionName("firstAction")] firstAction(string Id)
{.....
.....
}
[httpget]
[ActionName("secondAction")] secondAction(Int Id)
{.....
.....
}
//Now go to webroute.config file under App-start folder and add following
routes.MapHttpRoute(
name: "firstAction",
routeTemplate: "api/{controller}/{action}/{id}",
defaults: new { id = RouteParameter.Optional }
);

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

简单的选择

只需使用查询字符串即可。

路由

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

控制者

public class TestController : ApiController
{
    public IEnumerable<SomeViewModel> Get()
    {
    }

    public SomeViewModel GetById(int objectId)
    {
    }
}

要求

GET /Test
GET /Test?objectId=1

注意

请记住，查询字符串参数不应为“ id”或已配置路由中的任何参数。

修改WebApiConfig并在末尾添加另一个Routes.MapHttpRoute，如下所示：

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

然后创建一个像这样的控制器：

public class ServiceController : ApiController
{
        [HttpGet]
        public string Get(int id)
        {
            return "object of id id";
        }
        [HttpGet]
        public IQueryable<DropDownModel> DropDowEmpresa()
        {
            return db.Empresa.Where(x => x.Activo == true).Select(y =>
                  new DropDownModel
                  {
                      Id = y.Id,
                      Value = y.Nombre,
                  });
        }

        [HttpGet]
        public IQueryable<DropDownModel> DropDowTipoContacto()
        {
            return db.TipoContacto.Select(y =>
                  new DropDownModel
                  {
                      Id = y.Id,
                      Value = y.Nombre,
                  });
        }

        [HttpGet]
        public string FindProductsByName()
        {
            return "FindProductsByName";
        }
}

这就是我解决的方法。希望对您有所帮助。