$Rest¶

JSON veya XML içerik türlerini kullanarak REST hizmetleriyle etkileşime olanak tanır.

REST hizmeti aksiyonları şu nesneleri içerir: RestClient, RestRequestve RestResponse.

1

const $Rest;

Notlar¶

REST İstemcisi Oluşturma İstemci oluşturmak için, bir istemci oluşturmak üzere şu yöntemi kullanın: $Rest.Create REST hizmetinin temel URL'sini RestRequest.Url özelliği aracılığıyla sağlayın.

Örnek¶

1

var client = $Rest.Create('http://api.geonames.org/');

REST İstemcisinde Kimlik Doğrulaması Bazı REST hizmetleri kimlik doğrulaması gerektirir. Emakin, OAuth2 tabanlı kimlik doğrulamayı destekler. Kimliği doğrulanmış bir istemci oluşturmak için aşağıda gösterildiği gibi hizmeti ve kimliği belirtin. Bu yöntem hizmetten bir kimlik doğrulama belirteci alır ve istemcinin kimliğinin doğrulanmasını sağlar. Belirteç hizmetten alınamazsa, RestClient.EnsureAuthenticated yöntemi bir JavaScript özel durumu fırlatır. Aynı işlemi hata işleme olmadan gerçekleştirmek için RestClient.IsAuthenticated özelliğini ve RestClient.Authenticate yöntemini de kullanabilirsiniz.

Örnek¶

1

var client = $Rest.Create('https://graph.microsoft.com/v1.0/', 'Office365', '', $WorkItem.CompletedBy).EnsureAuthenticated();

REST İsteği Oluşturma İstemci bağlantısını oluşturduktan sonra, aşağıda gösterildiği gibi bir REST isteği oluşturabilir ve parametreleri doldurabilirsiniz.

Örnek¶

1
2
3

var request = client.Request('childrenJSON')
                .AddQueryParameter('username', 'demo')
                .AddQueryParameter('geonameId', id);

Kaynak URL adresiyle oluşturulan her istek istemcinin temel URL'sine eklenir. İstek URL'si, aşağıdaki sitePath parametrede gösterildiği gibi dinamik URL adresi oluşturmak için parametreler içerebilir.

Örnek¶

1
2
3

var request = client.Request("sites/{sitePath}/drives")
                .AddUrlParameter("sitePath", sitePath)
                .AddQueryParameter("$select", "id,name");

REST İsteğini Doldurma HTTP üstbilgilerini şu yöntemi kullanarak da ayarlayabilirsiniz: RestRequest.AddHeader yöntemi. Bazı REST yöntemleri JSON veya XML tabanlı bir gövde gerektirir. İstek içeriğini şu yöntemleri kullanarak belirtebilirsiniz: RestRequest.AddObject veya RestRequest.AddXml yöntemleri.

REST Yanıtını Alma İsteği doldurduktan sonra, isteği yürütmek ve şu nesneyi almak için şu yöntemi çağırabilirsiniz: RestRequest.Execute yöntemiyle isteği yürütün ve şu nesneyi alın: RestResponse nesnesi. Varsayılan olarak Execute yöntem herhangi bir hata denetimi gerçekleştirmez. İsteğin başarıyla yürütüldüğünden emin olmak için beklenen durum kodunu belirtmek üzere şu yöntemi kullanın: RestRequest.Expect yöntemini kullanarak beklenen durum kodunu belirtin.

Örnek¶

1
2
3
4
5
6

var response = request.Execute();

if (response.StatusCode == "OK") {
    var val = response.GetHeader('X-Header');
    var obj = response.ToJson();
}

REST İstek Yöntemleri Hizmeti ilgili HTTP yöntemiyle çağırmak için şu yöntemleri de kullanabilirsiniz: RestRequest.Get, RestRequest.Delete, RestRequest.Put, RestRequest.Postve RestRequest.Patch yöntemleri. Alternatif olarak, isteği yürütmeden önce şu özelliği el ile ayarlayabilirsiniz: RestRequest.Method isteği yürütmeden önce.

Hizmet her zaman JSON veya XML döndürüyorsa, yanıtı sırasıyla JSON nesnesi veya XML düğümü olarak almak için şu yöntemleri kullanabilirsiniz: RestRequest.ExecuteJson veya RestRequest.ExecuteXml yanıtı sırasıyla JSON nesnesi veya XML düğümü olarak almak için.

Örnek¶

1
2
3

var object = request.ExecuteJson();

// object.person.name;

Özellikler¶

İstemci Oluşturma¶

• Rest.Create: Yeni bir RestClient iş akışı örneği oluşturur.