Harici API İsteği

Çok fazla teori değil mi?

Bunu uygulamaya koyalım. AppMaster'ı açalım , onu kullanarak bir API isteği oluşturalım ve bu isteğin nasıl çalıştığını daha iyi anlayalım.

Harici API İsteği Oluşturma

API istekleri, "Harici API İstekleri" sekmesindeki "İş mantığı" bölümünde oluşturulur.

"+ Yeni API İsteği" ni tıklamanın zamanı geldi

İsim ve açıklama herhangi bir şeye ayarlanabilir, bunlar sadece bizim kişisel kullanımımız içindir.

Gerçekten önemli olan verilerle ilgilenelim.

Bir istek oluşturmak için gereken minimum, Yöntemini ve adresini (URL) belirtmektir. Sonuncusuyla başlayalım.

URL

URL - Tekdüzen Kaynak Bulucu. İnternette belirli bir kaynağa verilen adres. Böyle bir kaynağın en tanıdık sürümü bir HTML sayfasıdır - URL'sini tarayıcının adres çubuğuna girip istenen siteyi açıyoruz. Aynı zamanda, kaynağın kendisi herhangi bir şey, bir resim, bir video, bir veri seti olabilir. Ana şey, bu kaynağın belirli bir işaretçisi olmasıdır - bu kaynağı almak için istek gönderebileceğiniz bir URL.

yöntemler

Adresindeki verilere atıfta bulunarak, isteğin yöntemini (türünü de söyleyebilirsiniz) yani aslında bu verilerle ne yapılması gerektiğini belirtiyoruz.

İlk modülün görevi için istek gönderdiğimizde veri aldık. Bu GET yöntemidir. Bu yöntem en belirgin yöntemdir ve aynı zamanda gerekli olan tek yöntemdir. Bu nedenle, açıkça belirtmemiş olsak bile, varsayılan olarak bunun GET olduğu varsayıldı.

Bakalım başka hangi yöntemler var.

HTTP standardının kendisi kullanılabilecek yöntemlerin sayısını sınırlamaz. Aynı zamanda, uyumluluğu korumak için hala en standart yöntemlerden bazıları kullanılmaktadır. AppMaster API isteklerinde kullanılabilecek 5 farklı yöntem vardır.

GET . Zaten halledilir. Yöntem, bir kaynağın sağlanmasını ister ve verileri alır.

POST . Bir yerden veri almak için önce bu veriyi oraya yerleştirmeniz gerekir. POST yöntemi tam da bunu yapar. Sunucuya veri gönderir, bir kaynak oluşturur.

KOY . POST yöntemine benzer, ancak görevi verileri güncellemektir. Yeni veri oluşturmaz, mevcut verileri değiştirir, günceller.

SİL Adından da anlaşılacağı gibi, verileri siler.

yama . Yöntem PUT'a benzer, ancak verileri tamamen değiştirmek yerine kısmen güncellemek için kullanılır. Örneğin, PATCH yöntemini kullanarak bir makalenin başlığını değiştirebilir veya bazı parametrelerin değerini değiştirebilirsiniz.

Sunucunun yöntemde belirtilenleri tam olarak yapması gerekmediği gerçeğini dikkate almak önemlidir. DELETE yöntemiyle bir sayfanın adresini gönderebiliriz ancak bu, sunucunun onu gerçekten sileceği anlamına gelmez. Ancak, tamamen teorik olarak, bunu GET komutuyla yapabilir. Veya hiçbir şeyi değiştirmeyin, aynı zamanda POST'a yanıt olarak veri gönderin. Sadece geliştirici bu şekilde yapılandırdığı için.

İşte burada REST devreye giriyor, bu da siparişe uyulması konusunda anlaşmanın, karışıklığı durdurmanın ve yöntemde tam olarak belirtilenleri yapmanın zamanının geldiğini söylüyor. En azından ana görev bu olmalıdır (her ne kadar tek görev olmasa da). Örneğin, bir makalenin içeriğini GET yöntemini kullanarak aktarırken, aynı zamanda görüntüleme sayısının sayacını 1 artırabilirsiniz.

Böylece verilerin nerede olduğunu ve onunla neler yapılabileceğini anladık. Daha ileri gidelim, isteğin başka hangi bileşenlerine sahip olabileceğini görelim.

URL Parametreleri

URL Parametreleri . URL'nin yalnızca bir kısmını bildiğimiz durumlar vardır. Bir örnek, Appmaster.io web sitesindeki makalelerdir. Tüm makalelerin başlangıç ​​adresi aynıdır - https://appmaster.io/blog/ . Ancak her makalenin kendi başlığı ve buna bağlı olarak bu makalenin tam olarak belirtilmesi için kendi bireysel bölümü vardır.

Böyle bir durumda URL Paramları kullanılır. Genel kısmı hemen yazıyoruz ve gerisini süreçte karar vermeye bırakıyoruz. Sonuç olarak, URL https://appmaster.io/blog/:id/ biçiminde yazılır.

Bilinen kısım olduğu gibi yazılır ve değişken kısım “:” işaretinden sonra yerleştirilir. Bu değişken parçasının adı (zaten “:” olmadan) parametre listesine eklenir. Bu durumda, birkaç değişken parça olabilir ve bunların konumu URL'de herhangi bir yerdedir.

Sorgu Parametreleri

Sorgu Parametreleri . İlk modülde can sıkıntısı.com'a istek gönderdiğimizi hatırlıyor musunuz? Ve adrese ek olarak, ek veriler reçete edildi. Sorgu Paramları buydu.

URL'den sonra yazılırlar ve URL'den bir "?" ile ayrılırlar. işaret. Parametrenin adı, “=” işareti ve parametrenin kendisinin değeri belirtilir. Aynı anda birden fazla parametre kullanılıyorsa, bunlar “&” işaretiyle ayrılır.

Ancak AppMaster'da parametreleri belirlerken istek kurallarını düşünmeniz gerekmez. Her şey otomatik olarak uygun şekilde biçimlendirilecektir. Parametrenin adını belirtmeniz ve listeye eklemeniz yeterlidir.

Sorgu Paramları, veri kaynağı aynı olduğunda kullanılır, ancak verilerin kendisi farklı olabilir. Örneğin, Boredapi'de yapılacak çok şey var. Ama biz sadece bir kişiye yönelik olanlarla ilgilendik ve istek parametrelerinde bunu belirttik.

Başka bir kullanım durumu, veri miktarını sınırlamaktır. Örneğin, bir listeye erişebiliriz, ancak ondan yalnızca ilk 5 girişi talep edebiliriz. Bu miktar aynı zamanda bir sorgu parametresi olabilir.

Başka bir seçenek bir erişim anahtarıdır. Alphavantage'a atıfta bulunurken bu seçeneği modül 1'de kullanmış olabilirsiniz. Veriler ancak kayıt olduktan ve istek parametrelerinde kişisel bir anahtar gönderdikten sonra elde edilebilir.

İnternette ziyaret ettiğiniz sayfalara dikkat edin, muhtemelen onlarda da çeşitli parametreler bulacaksınız. Örneğin, Ventusky.com'un hava durumu sayfasını açın, sorgu parametrelerinde enlem ve boylamın coğrafi değerleri gönderilir.

Başlıklar

Başlıklar . Başlıkları isteyin. Genellikle başlıklar, istekle ilgili hizmet bilgilerini içerir (meta-bilgi). Başlıklar, sunucunun verileri isteyen istemci hakkında daha fazla bilgi almasına izin verir. Başlıklar, hangi tarayıcının kullanıldığı, yanıtın hangi kodlamada olması gerektiği, hangi dilde, isteğin tam zamanı ve daha fazlası hakkında bilgi içerebilir. Korunan verilere erişim durumunda, başlıklar bir yetkilendirme anahtarı içerebilir.

Çoğu durumda, başlıklar isteğe bağlıdır. İlk modülde bile, herhangi bir başlık belirtmediğimiz bir istekte bulunduk (ancak bu, isteğin aslında onlarsız gönderildiği anlamına gelmez).

Gövde

vücut . Beden iste. GET istekleri genellikle onsuz yapılır, ancak sunucuya bazı veriler göndermek, bir POST veya PUT isteği göndermek istiyorsak, bu veriler istek gövdesine yerleştirilir. Aynı zamanda, istek gövdesine herhangi bir karmaşıklıktaki verileri yerleştirebilir, örneğin bir video dosyası gönderebilir ve bir sayı veya metin dizesiyle sınırlı kalamazsınız.