Controlador único com vários métodos GET na API da Web do ASP.NET

Na Web API, eu tinha uma classe de estrutura semelhante:

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) { ... }
}

Como conseguimos mapear métodos individuais, era muito simples obter a solicitação certa no lugar certo. Para uma classe semelhante que tinha apenas um GETmétodo, mas também um Objectparâmetro, usei com sucesso IActionValueBinder. No entanto, no caso descrito acima, recebo o seguinte erro:

Multiple actions were found that match the request: 

SomeValue GetItems(CustomParam parameter) on type SomeType

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

Estou tentando abordar esse problema, substituindo o ExecuteAsyncmétodo de ApiControllermas sem sorte até agora. Algum conselho sobre esse assunto?

Editar: esqueci de mencionar que agora estou tentando mover esse código na API da Web do ASP.NET, que tem uma abordagem diferente ao roteamento. A questão é: como faço para que o código funcione na API da Web do ASP.NET?

Esta é a melhor maneira que encontrei para oferecer suporte a métodos GET extras e também aos métodos REST normais. Adicione as seguintes rotas ao seu 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)});

Eu verifiquei esta solução com a classe de teste abaixo. Consegui atingir com êxito cada método no meu controlador abaixo:

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)
    {
    }
}

Eu verifiquei que ele suporta os seguintes pedidos:

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

Observe que, se suas ações GET extras não começarem com 'Get', convém adicionar um atributo HttpGet ao método.

Vá a partir disso:

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

Para isso:

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

Portanto, agora você pode especificar para qual ação (método) você deseja enviar sua solicitação HTTP.

postar em "http: // localhost: 8383 / api / Command / PostCreateUser" chama:

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

e postar em "http: // localhost: 8383 / api / Command / PostMakeBooking" chama:

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

Eu tentei isso em um aplicativo de serviço de API WEB auto-hospedado e funciona como um encanto :)

Acho que os atributos são mais limpos de usar do que adicioná-los manualmente via código. Aqui está um exemplo simples.

[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);
    }

}

Você também precisa disso no seu 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 }
);

Some Good Links http://www.asp.net/web-api/overview/getting-started-with-aspnet-web-api/tutorial-your-first-web-api Este explica melhor o roteamento. http://www.asp.net/web-api/overview/web-api-routing-and-actions/routing-in-aspnet-web-api

Você precisa definir outras rotas no global.asax.cs como este:

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 }
);

Com o Web Api 2 mais novo, ficou mais fácil ter vários métodos de obtenção.

Se o parâmetro passado para os GETmétodos for diferente o suficiente para o sistema de roteamento de atributos diferenciar seus tipos, como é o caso de ints e Guids, você pode especificar o tipo esperado no campo[Route...] atributo

Por exemplo -

[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}";
    }
} 

Para mais detalhes sobre essa abordagem, clique aqui http://nodogmablog.bryanhogan.net/2017/02/web-api-2-controller-with-multiple-get-methods-part-2/

Outra opção é fornecer aos GETmétodos rotas diferentes.

    [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";
        }
   }

Veja aqui para mais detalhes - http://nodogmablog.bryanhogan.net/2016/10/web-api-2-controller-with-multiple-get-methods/

No ASP.NET Core 2.0, você pode adicionar o atributo Route ao controlador:

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

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

Eu estava tentando usar o roteamento de atributos da Web Api 2 para permitir vários métodos Get, e eu incorporara as sugestões úteis das respostas anteriores, mas no Controller eu havia decorado apenas o método "especial" (exemplo):

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

... sem também colocar um [RoutePrefix] na parte superior do controlador:

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

Eu estava recebendo erros informando que não foi encontrada nenhuma rota correspondente ao URI enviado. Depois que o [Route] decorava o método e o [RoutePrefix] decorava o Controller como um todo, funcionou.

Não tenho certeza se você encontrou a resposta, mas fiz isso e funciona

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";
}

Agora no 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 }
);

Você já tentou mudar para WebInvokeAttribute e definir o método como "GET"?

Acredito que tive um problema semelhante e mudei para informar explicitamente qual método (GET / PUT / POST / DELETE) é esperado na maioria dos métodos, se não todos.

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) { ... }
}

O WebGet deve lidar com isso, mas já vi alguns problemas com o Get múltiplo e muito menos o Get do mesmo tipo de retorno.

[Editar: nada disso é válido com o pôr do sol do WCF WebAPI e a migração para o ASP.Net WebAPI na pilha MVC]

**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) { ... }
    }

A alternativa de preguiça / pressa (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;}

Ligando para eles:

localhost: 5000 / api / nome_do_controlador / método1-42

"olá42"

localhost: 5000 / api / nome do controlador / método 2-99

"world99"

Nenhum dos exemplos acima funcionou para minhas necessidades pessoais. A seguir, é o que acabei fazendo.

 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;             

    }

Para usar o acima em sua rota, use:

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) });

O que acontece é o tipo de restrição de falhas no método, para que essa rota corresponda apenas aos métodos padrão GET, POST, PUT e DELETE. O "true" diz que queremos verificar se há uma correspondência dos itens na matriz. Se fosse falso, você estaria dizendo excluir aqueles no strVocê pode usar rotas acima deste método padrão, como:

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

No exemplo acima, ele está basicamente procurando o seguinte URL => http://www.domain.com/Account/Status/Activeou algo parecido.

Além do exposto, não tenho certeza se ficaria louco demais. No final do dia, deve ser por recurso. Mas vejo a necessidade de mapear URLs amigáveis ​​por vários motivos. Estou me sentindo bastante certo, à medida que a Web Api evolui, haverá algum tipo de provisão. Se tiver tempo vou construir uma solução mais permanente e postar.

Não foi possível fazer com que nenhuma das soluções de roteamento acima funcione - algumas das sintaxes parecem ter mudado e eu ainda sou novo no MVC - em uma pitada, apesar de eu ter reunido esse truque realmente terrível (e simples) que vai me deixar por enquanto - note, isso substitui o método "public MyObject GetMyObjects (long id)" - alteramos o tipo de "id" para uma string e alteramos o tipo de retorno para objeto.

// 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;
}

Se você tiver várias ações no mesmo arquivo, passe o mesmo argumento, por exemplo, ID para todas as ações. Isso ocorre porque a ação pode apenas identificar o ID. Portanto, em vez de atribuir qualquer nome ao argumento, declare o ID dessa forma.

[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 }
);

Alternativa Simples

Basta usar uma string de consulta.

Encaminhamento

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

Controlador

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

    public SomeViewModel GetById(int objectId)
    {
    }
}

solicitações de

GET /Test
GET /Test?objectId=1

Nota

Lembre-se de que o parâmetro da cadeia de caracteres de consulta não deve ser "id" ou qualquer que seja o parâmetro na rota configurada.

Modifique o WebApiConfig e adicione no final outro Routes.MapHttpRoute como este:

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

Em seguida, crie um controlador como este:

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";
        }
}

Foi assim que eu resolvi. Espero que ajude alguém.