API'lere Kodsuz Bağlanma: 8 Adım

2024 Yazar: John Day | [email protected]. Son düzenleme: 2024-01-30 13:17

Bu kılavuz, bir API kullanmayı gerektiren, ancak nasıl başlayacağından tam olarak emin olmayan bir şeyi başarmak isteyen kişiler için tasarlanmıştır. Bir API ile çalışmanın neden yararlı olduğunu zaten biliyorsunuz ve bu kılavuz size bunu nasıl yapacağınızı gösterecek.

Bu size benziyorsa, şanslısınız! API'lerle nasıl çalışılacağını, API belgelerinin nasıl okunacağını ve bir API'den gelen verilerin gerçekte nasıl kullanılacağını açıklamak için buradayız.

Yolculuğu çok daha kolay hale getirmek için bir arkadaşımızı getirdik.

Slash ile tanışın

Slash, Michelle'in sevimli, sevimli köpeğidir (yukarıdaki resimde). Michelle, API'ler oluşturan bir yazılım mühendisidir. Michelle işinden gerçekten keyif alıyor ve Slash eğitiminde API'ler oluşturma çalışmasından ilham aldı.

Bildiğiniz gibi API, kullanıcının istekle eşleşen bir dizi yanıtla birlikte bir web hizmetine verebileceği bir komutlar topluluğudur. Michelle, Slash'i de aynısını yapması için eğitti. Slash iyi bir çocuktur, çeşitli komutları bilir ve ona öğrettiği bir istekte bulunduğunuz sürece her zaman doğru yanıt verir. Fazladan heyecanlandığında kuyruğu çıldırıyor - bu, Michelle'in API'lerle ilgili olarak ona öğrettiği bir şey değil, sadece sevimli bir yavru olduğu ve eğitiminden gerçekten keyif aldığı için!

1. Adım: İhtiyacınız Olan API'ye Karar Verin

Hangi bilgileri arıyorsunuz veya değiştirmek istiyorsunuz?

@dougthepug'un tüm Instagram gönderilerini almaya mı çalışıyorsunuz? Belki de köpeğinizin twitter'ını takip eden herkese otomatik olarak tweet atmak isteyebilirsiniz (çünkü köpekler konuşamasa da söyleyecek çok şeyleri vardır, Slash'in bunu yaptığından eminiz).

Bağlanmaya çalıştığınız siteyi veya API'yi zaten biliyorsanız, doğrudan 2. Adıma gidin. Veri bulmaya çalışıyor ancak nereden başlayacağınızdan emin değilseniz, Google arkadaşınızdır. "[İlgilendiğiniz şeyler] API'sini" arayın ve ne olduğunu görün. Orada ne kadar çok bilgi olduğuna şaşırabilirsiniz.

Basit bir örnek API isterseniz, Michelle'in Slash eğitimi sırasında yaptığı API'yi kullanabilirsiniz. Topları almak ve delik kazmak gibi en sevdiği komutlardan bazılarına sahiptir. Örneklerimizin geri kalanında kullanacağız.

2. Adım: API Dokümanlarını Bulun

Tanınmış şirketler tarafından sağlanan API'ler, bunların nasıl kullanılacağına ilişkin kapsamlı belgelere sahip olmalıdır.

Bunları bulmak için "[Şirket Ekle] API belgelerini" veya "[Şirketi Ekle] geliştiricisini" google.

Sonuçlar sizi geliştirici portalına götürmelidir. "Belgeler", "Belgeler", "Referans" veya "Teknik Referans" yazan bir bağlantı arayın.

Bazen birçok seçenek olabileceğinden, dokümanlar içinde istediğiniz belirli API'yi aramanız gerekebilir. Örneğin Facebook, pazarlama, reklamlar, sayfalar ve daha fazlası için ayrı API'lere sahiptir.

Bağlanmak istediğiniz API iyi bilinmiyorsa (Slash's gibi) geliştiriciden belge istemeniz gerekebilir. İhtiyacınız olan bilgileri içeren bir PDF'ye veya web sitelerinde listelenmeyen çevrimiçi belgelere sahip olabilirler.

Önceki adımdaki bağlantıyı kaçırdıysanız, Slash'ın API belgelerine buradan ulaşabilirsiniz.

3. Adım: Uç Noktayı Bulun

API dokümanları göz korkutucu görünebilir, ancak ne arayacağınızı öğrendikten sonra genellikle iyi yapılandırılmış ve oldukça standart hale getirilmiştir.

Aranacak ilk şey uygun uç nokta(lar)dır. İstediğiniz her veri türüne karşılık gelen bir uç nokta olmalıdır. Bir uç nokta şöyle görünebilir:

slashtheapidog.com/api/bones/{id}

ya da sadece

/kemikler

Belgelerde uç noktaların bir listesi olmalıdır. Belgelerde en üst düzeyde veya "referans", "uç noktalar" veya "yöntemler" adlı bir bölümün altında olabilirler. Doğru uç noktayı bulmak için aradığınız verilere karşılık gelen adı arayın. Örneğin, Slash'in kazdığı tüm deliklerin bir listesini istiyorsanız, /holes muhtemelen doğru olanıdır. Her durumda, her uç noktanın ne yaptığını açıklamaya yardımcı olacak bir açıklaması olmalıdır.

Dokümanlarından, Slash'ın API'sindeki deliklerle ilgili uç noktalar şunlardır:

slashtheapidog.com/api/holes ALIN

slashtheapidog.com/api/holes/{id} ALIN

POST

PUT

POST

4. Adım: Talep Türünüzü Belirleyin

Artık doğru uç noktayı bulduğunuza göre, göndermek için istek türünü belirlemeniz gerekir.

4 farklı istek türü vardır:

ELDE ETMEK

Bir GET isteği, API'den sahip olduğu bir şeyle, çoğunlukla verilerle yanıt vermesini istemenizdir. Uç nokta ve parametrelere dayalı olarak bir öğe veya bir grup öğe hakkında özel bilgiler isteyebilirsiniz. Bu, Slash'tan size kemiklerinden birini veya tüm kemiklerini getirmesini istemekle eşdeğerdir.

İLETİ

POST isteği, API'ye yeni bir şey yaratmasını nasıl söylediğinizdir. Bu, Slash'tan sizin için yeni bir delik açmasını (yaratmasını) istemeye benzer.

KOYMAK

PUT isteği, API'ye önceden oluşturulmuş bir şeyi güncellemesini nasıl söylediğinizdir. Bu, Slash'tan kazdığı deliğe daha derine inmesini (güncellenmesini) istemeye benzer.

SİLMEK

DELETE isteği, API'ye önceden oluşturulmuş bir şeyi silmesini nasıl söylediğinizdir. Bu, Slash'tan daha önce kazdığı bir deliği kapatmasını (silmesini) istemeye benzer.

Bu dört türü düşünün. Bilgi mi alıyorsunuz, yeni bir giriş mi oluşturuyorsunuz, mevcut bir girişi mi değiştiriyorsunuz yoksa bir girişi mi siliyorsunuz? Bu cevap size tam olarak hangi istek tipine ihtiyacınız olduğunu söyler.

Adım 5: Parametreleri Anlayın

Birçok istek ek parametreler gerektirir. Parametreler, talebinizin ayrıntılarıdır. Örneğin, Slash'in kırmızı olan tüm topları size getirmesini istiyorsanız, rengi belirtmeniz gerekir. Yeni bir delik açmasını istiyorsanız, ona nereye koyacağını ve ne kadar derin kazacağını söylemelisiniz.

Başvuruda bulunduğunuz API belgelerinin, her uç nokta ve istek türü için "Parametreler" veya "Seçenekler" adlı bir bölümü olmalıdır. Bazıları isteğe bağlı olduğundan, hangi parametrelerin gerekli olduğuna dikkat edin. Bir parametre isteğe bağlı olarak işaretlenmişse, dokümanlar aynı zamanda varsayılan olan bir örnek sağlayabilir.

Slash'in API parametreleri, topları almak için şöyle görünebilir:

slashtheapidog.com/api/balls'ı ALIN

6. Adım: İsteğinizi Biçimlendirin

İhtiyacımız olan tüm bilgilere sahibiz, şimdi sadece talepte bulunmamız gerekiyor!

Kod gerektirmeyen bir API'ye bağlanmanın iki farklı yolu aşağıda verilmiştir. https://slashtheapidog.com/api/balls adresine bir GET isteğinde bulunarak Slash'ın top listesini almak için Slash'ın API'sine bağlanalım.

Parabol - Eğer kodsuz veriye bağlanmak ve veri ile çalışmak istiyorsanız

Parabola, API'lere kolayca bağlanmanıza ve ardından görsel, sürükle ve bırak aracıyla verilerle çalışmanıza olanak tanıyan bir web uygulamasıdır.