Як слід передавати кілька параметрів веб-API GET ASP.Net?

Я використовую .Net MVC4 Web API, щоб (сподіваюся) реалізувати RESTful api. Мені потрібно передати декілька параметрів до системи та дозволити їй виконати певну дію, а потім повернути список об’єктів як результати. Конкретно я проходжу в дві дати та повертаю записи, які потрапляють між ними. Я також стежу за поверненими записами, щоб наступні дзвінки не перероблялися в системі.

Я розглянув кілька підходів:

1. Серіалізація парам в один рядок JSON та виділення його в API. http://forums.asp.net/t/1807316.aspx/1

2. Передайте парами у рядок запиту.
   Який найкращий спосіб передати кілька параметрів запиту спокійному api?

3. Визначення парам в маршруті: api / controller / date1 / date2

4. Використання POST, яке по суті дозволяє мені передавати об'єкт парамами.

5. Дослідження ODATA, оскільки Web API (на даний момент) його підтримує. Я ще багато не робив з цим, тому не дуже знайомий з цим.

Здається, що правильна практика REST вказує, коли дані витягуються, ви повинні використовувати GET. Однак GET також повинен бути нульопотентним (не створює побічних ефектів), і мені цікаво, чи не порушує моя конкретна реалізація, оскільки я маркую записи в системі API, отже, я створюю побічні ефекти.

Це також привело мене до питання підтримки змінних параметрів. Якщо список вхідних параметрів змінюється, було б нудно переосмислити свій маршрут для вибору 3, якщо це трапляється багато. І що може статися, якщо параметри визначені під час виконання ...

У будь-якому випадку, для моєї конкретної реалізації, який вибір (якщо такий є) здається найкращим?

Що означає це маркування записів? Якщо це використовується лише для цілей реєстрації, я б використовував GET і вимикав усі кешування, оскільки ви хочете реєструвати кожен запит для цих ресурсів. Якщо маркування записів має інше призначення, POST - це шлях. Користувач повинен знати, що його дії впливають на систему та метод POST - це попередження.

Я думаю, що найпростіший спосіб - просто використовувати AttributeRouting.

У вашому контролері очевидно, чому ви хочете цього у вашому глобальному WebApiConfigфайлі?

Приклад:

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

В {}імена повинні відповідати вашим параметрам.

Так просто, тепер у вас є окремий, GETякий обробляє декілька парам у цьому випадку.

Просто додайте новий маршрут до WebApiConfigзаписів.

Наприклад, щоб зателефонувати:

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

додати:

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

Потім додайте параметри до виклику HTTP:

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

Мені просто довелося реалізувати RESTfull api, де мені потрібно передати параметри. Я зробив це, передавши параметри в рядку запиту в тому ж стилі, як описано в першому прикладі Марка "api / controller? Start = date1 & end = date2"

У контролері я використав підказку з розбиття URL-адреси в C #?

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

У моєму випадку я закликав WebApi через Ajax виглядаючи так:

$.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');
                       }
        }
   });

Я сподіваюся, що це допомагає ...

Я знайшов чудове рішення на 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
    }
}

Використання GET або POST чітко пояснюється @LukLed . Щодо способів передачі параметрів, я б запропонував перейти із другим підходом (я також мало знаю про ODATA ).

1.Серіалізація парам в один рядок JSON та виділення його в API. http://forums.asp.net/t/1807316.aspx/1

Це не зручно для користувачів та SEO

2.Задайте парами у рядку запиту. Який найкращий спосіб передати кілька параметрів запиту спокійному api?

Це звичайний переважний підхід.

3.Визначення парам в маршруті: api / kontroler / date1 / date2

Це, безумовно, не гарний підхід. Через це відчувається, що хтось date2є субресурсом, date1і це не так. І параметри запиту, date1і date2є, і знаходиться на одному рівні.

У простому випадку я б запропонував подібний URI,

api/controller?start=date1&end=date2

Але мені особисто подобається нижченаведена схема URI, але в цьому випадку ми повинні написати якийсь спеціальний код для відображення параметрів.

api/controller/date1,date2

Використовуйте прив'язку параметрів, як описати тут повністю: 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 ";
    }

Обидві парами кореневого посилання ({one}, {two}) та параметри функції Get (один, два) повинні бути однаковими

Я знаю, що це справді старе, але недавно я хотів те саме, і ось що я знайшов ...

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

Тож тепер у вашу адресу / URI / ...

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

Результат: "Знайдений тест"

http (s): // myURL / api / myController /? var = getnew & test = що завгодно

Результат: "Не вдалося знайти цей тест"

Тепер це можна зробити, просто скориставшись

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

це поверне: "значення: 5 10"

якщо ви називаєте це за допомогою https: // yourdomain / api / yourcontroller? 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");
            }
        }
    }