Bu blog yazısında, API ve PUT istekleri hakkında bilmeniz gereken her şeyi tartışacağız. Önce bir API'nin ne olduğunu açıklayarak başlayacağız, ardından bir PUT isteğinin ne olduğunu ve POST gibi diğer HTTP yöntemlerinden nasıl farklılaştığını inceleyeceğiz.
Size API için bazı en iyi uygulamalar ve yaygın yanıt formatları sunacak ve Apidog'da bir PUT isteğinin nasıl yapılacağını göstereceğiz.
Apidog'u ücretsiz indirerek keşfedin ve hemen test etmeye başlayın!
O halde, daha fazla uzatmadan, API ve PUT istekleri dünyasına dalalım!
API Nedir?
Bir API veya Uygulama Programlama Arayüzü, farklı uygulamaların birbiriyle iletişim kurmasını sağlayan, tanımlanmış bir dizi kuraldır. Siparişinizi alan ve mutfağa ileten, ardından yemeğinizi size geri getiren bir garson gibidir. API'ler, farklı yazılım bileşenlerinin kolayca ve güvenli bir şekilde iletişim kurmasına ve veri aktarmasına yardımcı olur. Yazılım geliştirme ve inovasyonu daha basit ve daha verimli hale getiren gizli sos gibidirler.
Örneğin, bir yolculuk rezervasyonu yapmak için bir mobil uygulama kullandığınızda, uygulama, sürücünün konumunu, ETA'sını ve diğer ayrıntıları almak için yolculuk çağırma hizmetinin sunucularıyla iletişim kurmak için bir API kullanır. Bu, uygulamanın bilgileri size gerçek zamanlı olarak görüntülemesine yardımcı olur.
Kısacası, API'ler, farklı yazılım bileşenlerini bir arada tutan, sorunsuz ve verimli bir şekilde çalışmalarını sağlayan yapıştırıcı gibidir.
PUT İsteği Nedir?
Bir PUT isteği, sunucudaki mevcut bir kaynağı güncellemek veya değiştirmek için kullanılan bir HTTP istek yöntemidir. Bir PUT isteği, yeni bir kaynak oluşturur veya hedef kaynağın bir temsilini istek yüküyle değiştirir.
İsteğin bir gövdesi vardır ve başarılı yanıtın bir gövdesi vardır. PUT isteği güvenli değildir ve idempotenttir. HTML formlarında izin verilmez. İşte bir PUT isteği örneği:
PUT /new.html HTTP/1.1
Host: example.com
Content-type: text/html
Content-length: 16
<p>New File</p>
Hedef kaynağın mevcut bir temsili yoksa ve PUT isteği başarıyla bir tane oluşturursa, kaynak sunucu, bir 201 (Oluşturuldu) yanıtı göndererek kullanıcı aracını bilgilendirmelidir. Hedef kaynağın mevcut bir temsili varsa ve bu temsil, eklenmiş temsilin durumuna uygun olarak başarıyla değiştirildiyse, kaynak sunucu, isteğin başarılı bir şekilde tamamlandığını belirtmek için bir 200 (Tamam) veya bir 204 (İçerik Yok) yanıtı göndermelidir.
PUT İsteği Nasıl Çalışır?
Bir HTTP PUT isteği yaptığınızda ve İstek-URI mevcut bir kaynağı gösterdiğinde, sunucu o kaynağı, PUT isteğinin gövdesinde bulunan verilerle tamamen değiştirir. İstek-URI mevcut bir kaynağı göstermiyorsa, sunucu o URL ile kaynağı oluşturabilir.
PUT ve POST İstekleri
Bir PUT isteği ile bir POST isteği arasındaki fark, bir PUT isteğinin idempotent olmasıdır, yani bir kez veya birkaç kez art arda çağrılması aynı etkiye sahiptir (yani yan etkisi yoktur), oysa art arda aynı POST istekleri, birkaç kez sipariş vermek gibi ek etkilere sahip olabilir. PUT istekleri, sunucudaki mevcut bir kaynağı güncellemek veya değiştirmek için kullanılırken, POST istekleri sunucuya bir kaynak eklemek için kullanılır.
API'de Bir PUT İsteği Nasıl Gönderilir?
Bir API'de bir PUT isteği göndermek için, HTTP yöntemini PUT ve güncellemek veya değiştirmek istediğiniz kaynağın URL'sini belirtmeniz gerekir. Ayrıca, kaynağın güncellenmiş temsilini istek yüküne dahil etmeniz gerekir. İşte requests kütüphanesini kullanarak Python'da bir PUT isteği örneği:
import requests
url = 'https://example.com/api/resource/1'
data = {'key': 'value'}
response = requests.put(url, json=data)
Bu örnekte, requests.put() yöntemi, kaynağın güncellenmiş temsilini data parametresinde belirterek belirtilen URL'ye bir PUT isteği gönderir. Sunucudan gelen yanıt, response değişkeninde saklanır.
Apidog'da Bir PUT İsteği Oluşturma ve Test Etme
Apidog, Postman, Swagger, Mock ve JMeter'ı bir araya getirerek, farklı sistemler arasındaki veri senkronizasyon sorununu bir dizi sistem ve bir dizi veri kullanarak ele alan, API dokümantasyonu, API hata ayıklama, API sahtekarlığı ve API otomatik testini birleştiren entegre bir işbirliği platformudur.
API dokümantasyonu, API hata ayıklama, API sahtekarlığı ve API otomatik testini sağlayan hepsi bir arada bir API işbirliği platformudur. Tek bir sistem ve merkezi veri ile Apidog, birden fazla sistemdeki veri senkronizasyonu sorununu çözer. API belgesi tanımlandıktan sonra, API hata ayıklama, veri sahtekarlığı ve API testi, yeniden tanımlamaya gerek kalmadan doğrudan kullanılabilir.
Apidog'da bir PUT isteği oluşturmak ve test etmek için şu adımları izleyebilirsiniz:
- Apidog'u Açın: Apidog'u açın ve yeni bir istek oluşturun.
2. HTTP yöntemini belirtin: HTTP yöntemi olarak PUT'u seçin.
3. İstek URL'sini tanımlayın: Güncellemek istediğiniz kaynağın URL'sini girin, istek başlıklarını ve/veya istek gövdesini ekleyin. Ardından PUT isteğini göndermek için "Gönder" düğmesine tıklayın
4. Yanıtı kontrol edin: PUT isteğinin başarılı olduğundan emin olmak için sunucudan gelen yanıtı kontrol edin.
API'de PUT İsteklerini Kullanmaya Yönelik En İyi Uygulamalar
API'de PUT isteklerini kullanmaya yönelik bazı en iyi uygulamalar şunlardır:
- Tutarlı bir yanıt formatı kullanın: PUT istekleri dahil olmak üzere tüm uç noktalarınız için tutarlı bir yanıt formatı kullanmak iyi bir fikirdir. Bu, istemcilerin API'nizi anlamasını ve onunla çalışmasını kolaylaştırabilir.
- Güncellemelerin idempotent olduğundan emin olun: İdempotent işlemler, istenmeyen etkilere neden olmadan birden çok kez tekrarlanabilen işlemlerdir. PUT istekleri idempotenttir, yani bir kez veya birkaç kez art arda çağrılması aynı etkiye sahiptir. Bunun nedeni, istek yükünün kaynağın güncellenmiş temsilini içermesidir. Kaynak yoksa, belirtilen temsille yeni bir kaynak oluşturulur.
- API tasarımını kaynaklar etrafında düzenleyin: REST API'leri, istemci tarafından erişilebilen her türlü nesne, veri veya hizmet olan kaynaklar etrafında tasarlanmıştır. Bir kaynağın, o kaynağı benzersiz bir şekilde tanımlayan bir URI olan bir tanımlayıcısı vardır. Örneğin, belirli bir müşteri siparişinin URI'si şu şekilde olabilir:
https://example.com/orders/1. - API işlemlerini HTTP yöntemleri cinsinden tanımlayın: REST API'leri, kaynaklar üzerinde işlemler gerçekleştirmek için standart HTTP yöntemlerini kullanır. En yaygın işlemler GET, POST, PUT, PATCH ve DELETE'dir. PUT istekleri, sunucudaki mevcut bir kaynağı güncellemek veya değiştirmek için kullanılırken, POST istekleri sunucuya bir kaynak eklemek için kullanılır.
- HTTP semantiğine uyun: REST API'leri HTTP semantiğine uymalıdır. Örneğin, PUT istekleri mevcut bir kaynağı güncellemek veya değiştirmek için kullanılırken, POST istekleri sunucuya bir kaynak eklemek için kullanılmalıdır. Bu, API'nizin tutarlı ve kullanımı kolay olmasını sağlamaya yardımcı olur.
PUT İsteğinden Bazı Yaygın Yanıt Formatları
Bir PUT isteği için yanıt formatı, API tasarımına ve belirli kullanım durumuna bağlıdır. Ancak, PUT istekleri dahil olmak üzere tüm uç noktalarınız için tutarlı bir yanıt formatı kullanmak iyi bir uygulamadır. İşte PUT istekleri için bazı yaygın yanıt formatları:
- HTTP durum kodu 200 OK: Bu durum kodu, mevcut bir kaynağa yapılan bir güncellemenin başarılı bir PUT'u için döndürülür. Yanıt gövdesine gerek yoktur. HTTP durum kodu 204 İçerik Yok daha da uygundur.
- HTTP durum kodu 201 Oluşturuldu: Bu durum kodu, yeni bir kaynağın başarılı bir PUT'u için döndürülür; yeni kaynak için en özel URI, Konum başlık alanında döndürülür ve kaynağın diğer ilgili URI'leri ve meta verileri yanıt gövdesinde yankılanır.
- HTTP durum kodu 409 Çatışma: Bu durum kodu, üçüncü taraf bir değişiklik nedeniyle başarısız olan bir PUT için, yanıt gövdesinde denenen güncelleme ile mevcut kaynak arasındaki farkların bir listesiyle döndürülür.
- HTTP durum kodu 400 Hatalı İstek: Bu durum kodu, PUT'un neden başarısız olduğunu açıklayan, yanıt gövdesinde doğal dilde metin (örneğin İngilizce) ile başarısız bir PUT için döndürülür.
Sonuç
Bu blog yazısında, bir sunucuda bir kaynak oluşturmak veya güncellemek için kullanılan bir HTTP yöntemi olan PUT hakkında bilgi edindik. Mevcut kaydı güncellemek için kullanılır ve kayıt yoksa yenisini oluşturur. POST ve PUT istekleri arasındaki temel fark, İstek-URI'nin farklı anlamlarında yatmaktadır.
Bir API tasarlarken, istekte hangi nesneye başvurduğunuza bağlı olarak doğru yöntemi kullanmak önemlidir. URL nesnelerini açıkça adlandırırsanız, PUT kullanın.
Ek olarak, Apidog API Geliştirme Araç Takımı'nı kullanarak API'leri nasıl oluşturacağımızı ve test edeceğimizi öğrendik. Bu araç takımı, API'leri daha hızlı ve birlikte tasarlamanıza ve geliştirmenize olanak tanır. 🚀
