Como devo passar vários parâmetros para um GET da API da Web do ASP.Net?

Eu estou usando a API da Web .Net MVC4 para (espero) implementar uma API RESTful. Preciso passar alguns parâmetros para o sistema e fazê-lo executar alguma ação e, em seguida, retornar uma lista de objetos como resultado. Especificamente, estou passando em duas datas e retornando registros que caem entre elas. Também acompanho os registros retornados para que as chamadas subseqüentes não sejam reprocessadas no sistema.

Eu considerei algumas abordagens:

1. Serializando os parâmetros em uma única cadeia JSON e separando-a na API. http://forums.asp.net/t/1807316.aspx/1

2. Passe os parâmetros na string de consulta.
   Qual é a melhor maneira de passar vários parâmetros de consulta para uma API repousante?

3. Definindo os parâmetros na rota: api / controller / date1 / date2

4. Usando um POST que inerentemente me permite passar um objeto com parâmetros.

5. Pesquisando ODATA desde a API da Web (atualmente) suporta. Ainda não fiz muito com isso, então não estou muito familiarizado com isso.

Parece que as práticas REST adequadas indicam quando os dados são extraídos, você deve usar um GET. No entanto, o GET também deve ser nulipotente (não produz efeitos colaterais), e me pergunto se minha implementação específica viola isso, já que marquei registros no sistema da API, portanto, estou produzindo efeitos colaterais.

Também me levou à questão de suportar parâmetros variáveis. Se a lista de parâmetros de entrada mudar, seria tedioso redefinir sua rota para a Opção 3 se isso acontecer muito. E o que pode acontecer se os parâmetros forem definidos em tempo de execução ...

De qualquer forma, para minha implementação específica, qual opção (se houver) parece melhor?

O que significa essa marcação de registro? Se isso for usado apenas para fins de log, eu usaria GET e desabilitaria todo o cache, pois você deseja registrar todas as consultas desses recursos. Se a marcação de registro tiver outro objetivo, o POST é o caminho a percorrer. O usuário deve saber que suas ações afetam o sistema e o método POST é um aviso.

Eu acho que a maneira mais fácil é simplesmente usar AttributeRouting.

É óbvio dentro do seu controlador, por que você quer isso no seu global WebApiConfigde arquivo?

Exemplo:

    [Route("api/YOURCONTROLLER/{paramOne}/{paramTwo}")]
    public string Get(int paramOne, int paramTwo)
    {
        return "The [Route] with multiple params worked";
    }

Os {}nomes precisam corresponder aos seus parâmetros.

Simples assim, agora você tem um separado GETque lida com vários parâmetros neste exemplo.

Basta adicionar uma nova rota às WebApiConfigentradas.

Por exemplo, para ligar para:

public IEnumerable<SampleObject> Get(int pageNumber, int pageSize) { ..

adicionar:

config.Routes.MapHttpRoute(
    name: "GetPagedData",
    routeTemplate: "api/{controller}/{pageNumber}/{pageSize}"
);

Em seguida, adicione os parâmetros à chamada HTTP:

GET //<service address>/Api/Data/2/10 

Eu apenas tive que implementar uma API RESTfull onde eu preciso passar parâmetros. Eu fiz isso passando os parâmetros na string de consulta no mesmo estilo descrito no primeiro exemplo de Mark "api / controller? Start = date1 & end = date2"

No controlador, usei uma dica do URL dividido em c #?

// uri: /api/courses
public IEnumerable<Course> Get()
{
    NameValueCollection nvc = HttpUtility.ParseQueryString(Request.RequestUri.Query);
    var system = nvc["System"];
    // BL comes here
    return _courses;
}

No meu caso, eu estava chamando o WebApi via Ajax da seguinte forma:

$.ajax({
        url: '/api/DbMetaData',
        type: 'GET',
        data: { system : 'My System',
                searchString: '123' },
        dataType: 'json',
        success: function (data) {
                  $.each(data, function (index, v) {
                  alert(index + ': ' + v.name);
                  });
         },
         statusCode: {
                  404: function () {
                       alert('Failed');
                       }
        }
   });

Eu espero que isso ajude...

Encontrei solução excelente em http://habrahabr.ru/post/164945/

public class ResourceQuery
{
   public string Param1 { get; set; }
   public int OptionalParam2 { get; set; }
}

public class SampleResourceController : ApiController
{
    public SampleResourceModel Get([FromUri] ResourceQuery query)
    {
        // action
    }
}

O uso de GET ou POST é explicado claramente por @LukLed . Em relação às maneiras pelas quais você pode passar os parâmetros, sugiro seguir a segunda abordagem (também não sei muito sobre o ODATA ).

1.Serializando os parâmetros em uma única string JSON e separando-a na API. http://forums.asp.net/t/1807316.aspx/1

Isso não é fácil de usar e de SEO

2.Passe os parâmetros na string de consulta. Qual é a melhor maneira de passar vários parâmetros de consulta para uma API repousante?

Esta é a abordagem preferível usual.

3.Definição dos parâmetros na rota: api / controller / date1 / date2

Definitivamente, essa não é uma boa abordagem. Isso faz parecer que alguém date2é um sub-recurso date1e esse não é o caso. Os parâmetros de consulta date1e date2são e vem no mesmo nível.

Em um caso simples, eu sugeriria um URI como esse,

api/controller?start=date1&end=date2

Mas eu pessoalmente gosto do padrão URI abaixo, mas, neste caso, precisamos escrever um código personalizado para mapear os parâmetros.

api/controller/date1,date2

Use a Ligação de Parâmetros conforme descrito aqui: http://www.asp.net/web-api/overview/formats-and-model-binding/parameter-binding-in-aspnet-web-api

 [Route("api/controller/{one}/{two}")]
    public string Get(int One, int Two)
    {
        return "both params of the root link({one},{two}) and Get function parameters (one, two)  should be same ";
    }

Os parâmetros do link raiz ({one}, {two}) e os parâmetros da função Get (um, dois) devem ser iguais

Eu sei que isso é muito antigo, mas eu queria a mesma coisa recentemente e aqui está o que eu encontrei ...

    public HttpResponseMessage Get([FromUri] string var, [FromUri] string test) {
        var retStr = new HttpResponseMessage(HttpStatusCode.OK);
        if (var.ToLower() == "getnew" && test.ToLower() == "test") {
            retStr.Content = new StringContent("Found Test", System.Text.Encoding.UTF8, "text/plain");
        } else {
            retStr.Content = new StringContent("Couldn't Find that test", System.Text.Encoding.UTF8, "text/plain");
        }

        return retStr;
    }

Então agora em seu endereço / URI / ...

http (s): // myURL / api / myController /? var = getnew & test = test

Resultado: "Teste Encontrado"

http (s): // myURL / api / myController /? var = getnew & test = qualquer coisa

Resultado: "Não foi possível encontrar esse teste"

Agora você pode fazer isso simplesmente usando

        public string Get(int id, int abc)
        {
            return "value: " + id + "  " + abc;
        }

isso retornará: "value: 5 10"

se você chamá-lo com https: // seudominio / api / seuscontrolador? id = 5 & abc = 10

    public HttpResponseMessage Get(int id,string numb)
    {
        //this will differ according to your entity name
        using (MarketEntities entities = new MarketEntities())
        {
          var ent=  entities.Api_For_Test.FirstOrDefault(e => e.ID == id && e.IDNO.ToString()== numb);
            if (ent != null)
            {
                return Request.CreateResponse(HttpStatusCode.OK, ent);
            }
            else
            {
                return Request.CreateErrorResponse(HttpStatusCode.NotFound, "Applicant with ID " + id.ToString() + " not found in the system");
            }
        }
    }