ASP.Net Web API GET'ine birden çok parametreyi nasıl iletmeliyim?

(Umarım) bir RESTful API uygulamak için .Net MVC4 Web API kullanıyorum. Ben sisteme birkaç parametre geçmek ve bazı eylem gerçekleştirmek, sonra sonuçları olarak nesnelerin listesini döndürmek gerekir. Özellikle iki tarihte geçiyorum ve aralarında kalan kayıtları döndürüyorum. Ben de sonraki kayıtları sistemde yeniden işlenmez böylece döndürülen kayıtları takip ediyorum.

Birkaç yaklaşım düşündüm:

1. Parametreleri tek bir JSON dizesinde seri hale getirme ve API'de ayırma. http://forums.asp.net/t/1807316.aspx/1

2. Parametreleri sorgu dizesine iletin.
   Birden fazla sorgu parametresini dinlendirici bir API'ye geçirmenin en iyi yolu nedir?

3. Rotadaki parametreleri tanımlama: api / controller / date1 / date2

4. Doğal olarak bir nesneyi params ile geçirmeme izin veren bir POST kullanmak.

5. Web API (şu anda) desteklediğinden ODATA araştırılıyor. Ben henüz bu konuda pek bir şey yapmadım, bu yüzden çok aşina değilim.

Uygun REST uygulamaları, veri çekildiğinde bir GET kullanmanız gerektiğini gösterir. Bununla birlikte, GET ayrıca nullipotent olmalıdır (yan etki oluşturmaz) ve özel uygulamamın API sistemindeki kayıtları işaretlediğimden, yan etkiler ürettiğimi ihlal edip etmediğini merak ediyorum.

Ayrıca beni değişken parametreleri destekleme sorusuna götürdü. Giriş parametre listesi değişirse, çok fazla olursa Seçim 3 için rotanızı yeniden tanımlamak sıkıcı olacaktır. Ve parametreler çalışma zamanında tanımlanırsa ne olabilir ...

Her durumda, benim özel uygulama için, hangi seçenek (varsa) en iyi görünüyor?

Bu kayıt işareti ne anlama geliyor? Bu yalnızca günlüğe kaydetme amacıyla kullanılırsa, bu kaynaklar için her sorguyu günlüğe kaydetmek istediğiniz için GET kullanır ve tüm önbelleğe almayı devre dışı bırakırım. Kayıt işaretlemenin başka bir amacı varsa, POST yolu budur. Kullanıcı, eylemlerinin sistemi etkilediğini ve POST yönteminin bir uyarı olduğunu bilmelidir.

Bence en kolay yol sadece kullanmaktır AttributeRouting.

Oyun kumandanızda açık, neden Global WebApiConfigdosyanızda olmasını istesiniz?

Misal:

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

{}Adları parametreleri eşleşmesi gerekir.

Bu kadar basit, şimdi GETbu örnekte birden fazla parametreyi işleyen bir ayrıya sahipsiniz .

WebApiConfigGirişlere yeni bir rota eklemeniz yeterli .

Örneğin, aramak için:

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

Ekle:

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

Ardından parametreleri HTTP çağrısına ekleyin:

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

Sadece parametreleri geçirmem gereken bir RESTfull api uygulamak zorunda kaldım. Bunu Mark'ın ilk örnek "api / denetleyici? Start = date1 & end = date2" ile aynı stilde sorgu dizesinde geçirerek yaptım

Denetleyicide C #?

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

Benim durumumda Ajax üzerinden WebApi'yi şöyle çağırıyordum:

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

Umarım bu yardımcı olur...

Http://habrahabr.ru/post/164945/ adresinde mükemmel çözüm buldum

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

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

Kullanılması GET veya POST açıkça ile açıklanabilir @LukLed . Parametreleri geçmenin yolları ile ilgili olarak, ikinci yaklaşımla devam etmenizi öneririm ( ODATA hakkında da fazla bir şey bilmiyorum ).

1.Paramları tek bir JSON dizesine serileştirmek ve API'de ayırmak. http://forums.asp.net/t/1807316.aspx/1

Bu kullanıcı dostu ve SEO dostu değildir

2.Sorgu dizesindeki parametreleri geçin. Birden fazla sorgu parametresini dinlendirici bir API'ye geçirmenin en iyi yolu nedir?

Bu olağan tercih edilen yaklaşımdır.

Rotadaki parametreleri tanımlama: api / kontrolör / tarih1 / tarih2

Bu kesinlikle iyi bir yaklaşım değil. Bu, birisinin date2bir alt kaynağı olduğunu hissettirir date1ve durum böyle değildir. Hem ve date1hem date2de sorgu parametreleridir ve aynı düzeyde gelir.

Basit bir durumda böyle bir URI öneririm,

api/controller?start=date1&end=date2

Ama ben şahsen aşağıdaki URI desenini seviyorum ama bu durumda parametreleri eşleştirmek için bazı özel kodlar yazmamız gerekiyor.

api/controller/date1,date2

Tamamen burada açıklandığı gibi Parametre Bağlama kullanın: 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 ";
    }

Kök bağlantısının ({one}, {two}) ve Get işlev parametrelerinin (bir, iki) her iki parametresi aynı olmalıdır

Bunun çok eski olduğunu biliyorum, ama son zamanlarda aynı şeyi istedim ve bulduğum şey ...

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

Şimdi adresinizde / URI / ...

http (s): // myurl / API / myController / var = getnew ve test = Test

Sonuç: "Bulunan Test"

http (s): // myurl / API / myController / var = getnew & test = şey

Sonuç: "Bu test bulunamadı"

Şimdi bunu kullanarak

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

bu döndürecektir: "değer: 5 10"

eğer diyoruz ile ? // alan_adiniz / API / yourcontroller id = 5 & abc = 10: https

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