API:Etiquette/tr

Bu sayfa, API kullanılırken uyulması gereken en iyi uygulamaları içerir.

İstek sınırı
Okuma isteklerinde zor ve hızlı bir sınır yoktur, ancak düşünceli olun ve bir siteyi kaldırmamaya çalışın. Çoğu sistem hizmetlisi, sitelerinin kararlılığını tehlikeye atarsanız sizi belirsiz bir şekilde engelleme hakkını saklı tutar.

Yeni bir istek göndermeden önce bir isteğin bitmesini beklemek, isteklerinizi paralel yerine seri olarak yapmak güvenli bir talep oranıyla sonuçlanmalıdır. Ayrıca, bir istekte birden fazla öğe istemeniz de önerilir:


 * Her başlık için yeni bir istek yapmak yerine mümkün olduğunda boru karakterini kullanmak, örneğin.
 * Başka bir istekten her sonuç için istek yapmak yerine kullanmak.

Bant genişliği kullanımını azaltmak için  ayarlayarak API çağrıları yaparken GZip sıkıştırmasını kullanın.

Requests which make edits, modify state or otherwise are not read-only requests, are subject to rate limiting. The exact rate limit being applied might depend on the type of action and your user rights.

When you hit the request rate limit you will receive a with the error code. When you encounter this error, you may retry that request, however you should increase the time between subsequent requests. A common strategy for this is Exponential backoff.

Revizyonların ayrıştırılması
parametresini kullanarak belirli bir revizyon numarasından sonuçları sorgulamak mümkün olsa da, bu sunucular için pahalı bir işlemdir. Belirli bir düzeltmeyi almak için  parametresini kullanın. Örneğin:

Maxlag parametresi
Göreviniz etkileşimli değilse, yani bir kullanıcı sonucu beklemiyorsa,  parametresini kullanmalısınız. parametresinin değeri tamsayı saniye olmalıdır. Örneğin:

Bu, sunuculardaki yük yüksek olduğunda görevinizin çalışmasını engelleyecektir. Daha yüksek değerler daha agresif davranış anlamına gelir, daha düşük değerler daha iyidir.

Ayrıntılar için sayfasına bakın.

Kullanıcı-Aracı başlığı
Açıklayıcı bir Kullanıcı Aracısı başlığı ayarlamak en iyi yöntemdir. Bunu yapmak için  kullanın. Örneğin PHP'de:

Popüler bir web tarayıcısının kullanıcı aracısını kopyalamayın. Bu, bir sorun ortaya çıktığında nereden geldiğini takip etmenin kolay olmasını sağlar.

API'yi tarayıcı tabanlı JavaScript'ten çağırıyorsanız, tarayıcıya bağlı olarak  üst bilgisini etkileyemeyebilirsiniz. Bu sorunu gidermek için  üstbilgisini kullanın.

Daha fazla ayrıntı için m:Kullanıcı-Aracı politikası sayfasına bakın.

Veri biçimleri
Tüm yeni API kullanıcıları. Ayrıntılar için sayfasına bakın.

Performans
İstediğinizden daha yavaş sonuç alıyorsanız, genel olarak performansı düşünmenize yardımcı olması için okuyun.

Doğrudan veritabanlarından okumak yerine API üzerinden okumak müşterinizin performansını engelliyorsa, Wikimedia'nın Toolforge'una koyup koymayacağını düşünün.

Ayrıca bakınız

 * - Hızlı başlangıç kılavuzu.