MediaWiki API, görevlerin çoğunu tek bir komut dosyasında yapabilen, iyi belgelenmiş bir geliştirme araçları setidir. API genellikle wiki'de kullanılmak üzere otomatik araçların geliştirilmesi için kullanılır. MediaWiki API, Perl ve diğer birkaç dilin yanı sıra, özellikle PHP (Kıvırma işlevleri) başta olmak üzere çoğu dil tarafından kolayca kullanılabilir.
adımlar
Adım 1. MediaWiki API belgelerini okuyun
Her zamanki index.php ile aynı dizinde 'api.php'de bulunur. Örnek:
Adım 2. Bir çıktı formatı seçin
MediaWiki, JSON, JSONFM, PHP (serileştirilmiş format), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM ve RAWFM biçiminde veri çıktısı sunar. Son eki "FM" olan biçimler, HTML'de oldukça iyi yazdırılır.
Adım 3. Bir eylem seçin
MediaWiki API, aşağıdaki eylemleri destekler:
- yardım - Yardım ekranına bakın
- login - MediaWiki'ye giriş yapın
- opensearch - opensearch protokolünü uygula. (Tüm MediaWiki kurulumlarında buna sahip değildir).
- feedwatchlist - Bir izleme listesi beslemesi döndürür.
- sorgu - Çeşitli seçeneklere sahiptir. Onlar için MediaWiki API belgelerine bakın.
Adım 4. Bir sorgu veya liste seçin
Standart eylemlerin yanı sıra MediaWiki, başka bir makaleye bağlantı içeren sayfaları listeleme, son değişiklik farklarının sayısı, katkılar vb. gibi farklı sorguları ve listeleri destekler.
Adım 5. Yayınlanan verileri CURL veya POST yöntemini komut dosyasına kullanmanıza izin veren başka bir araç kullanarak API'ye iletin
GET yöntemi de işe yarayabilir.
Adım 6. Bir uygulamaya gönderilen çerezleri sakladığınızdan emin olun (Bazı komut dosyaları/uygulamalar bunu bir alt klasörde saklamak isteyebilir
7. Adım. MediaWiki kullanıcı arayüzü ile etkileşime girerken, düzenleme simgenizin çoğu düzenleme sayfasında tutulmasına dikkat edin
Düzenleme belirteci, düzenleme çakışmalarını belirlemek ve daha önce yapılmış başka bir düzenlemeyi geçersiz kılmaktan kaçınmak için kullanılır (Bu, geri almada da kullanılır.). Wiki'nin kullanıcı arayüzü ile hareket ediyorsanız işlerin ters gitmesinin daha kolay olduğunu unutmayın. Yalnızca amaçlanan sonucu yapacaklarından emin olmak için kullandığınız normal ifadelere dikkat edin.
Adım 8. Wiki tarafından gönderilen sonuçları okuyun
Sonuçlar, birçok ayrıştırıcı tarafından okunabilen bir HTTP yanıtında size gönderilecektir. Seçtiğiniz formata ekstra özen gösterin. Bu biçim için uygun ayrıştırıcıyı kullandığınızdan emin olun. Kullanmak istediğiniz varsayılan bir biçime sahip olsa bile, biçimi MediaWiki'ye açıkça belirtmek genellikle iyi bir uygulamadır.
İpuçları
- API'yi kullanmadan önce yerel wiki'nizin komut dosyası desteğine sahip olduğunuzdan emin olun.
- API'sini kullanarak MediaWiki hakkında daha fazla bilgi bulabilirsiniz.