$Rest¶

JSON veya XML içerik türlerini kullanarak REST hizmetleriyle etkileşim kurulmasını sağlar.

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

1

const $Rest;

Açıklamalar¶

REST İstemcisi Oluşturma İstemci oluşturmak için $Rest.Create REST hizmetinin temel URL'sini RestRequest.Url özelliği aracılığıyla sağlayarak bu yöntemi kullanın.

Örnek¶

1

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

REST İstemcisinin Kimliğini Doğrulama Bazı REST hizmetleri kimlik doğrulaması gerektirir. Emakin, OAuth2 tabanlı kimlik doğrulamayı destekler. Kimliği doğrulanmış bir istemci oluşturmak için hizmeti ve kimliği aşağıda gösterildiği gibi 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 JavaScript istisnası oluşturur. 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 parametrelerini 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. Aşağıdaki parametreyle gösterildiği gibi, dinamik bir URL adresi oluşturmak için istek URL'sinde parametreler bulunabilir: sitePath parametresi.

Örnek¶

1
2
3

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

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

REST Yanıtını Alma İsteği doldurduktan sonra, isteği yürütmek ve şu nesneyi almak için RestRequest.Execute yöntemini çağırabilirsiniz: RestResponse nesnesi. Varsayılan olarak Execute yöntem herhangi bir hata denetimi yapmaz. İ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öntemi.

Ö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 Ayrıca, hizmeti karşılık gelen HTTP yöntemiyle çağırmak için şu yöntemleri kullanabilirsiniz: RestRequest.Get, RestRequest.Delete, RestRequest.Put, RestRequest.Postve RestRequest.Patch yöntemleri. Alternatif olarak, isteği yürütmeden önce şu değeri elle ayarlayabilirsiniz: RestRequest.Method özelliğini.

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 yöntemlerini.

Örnek¶

1
2
3

var object = request.ExecuteJson();

// object.person.name;

Özellikler¶

İstemci Oluşturma¶

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