MediaWiki API adalah seperangkat alat pengembangan yang terdokumentasi dengan baik yang dapat melakukan sebagian besar tugas dalam satu skrip. API biasanya digunakan untuk pengembangan alat otomatis untuk digunakan di wiki. MediaWiki API dapat dengan mudah digunakan oleh sebagian besar bahasa, khususnya PHP (Fungsi curl) serta Perl dan beberapa lainnya..
Langkah
Langkah 1. Baca dokumentasi API MediaWiki
Itu terletak di 'api.php' di direktori yang sama dengan index.php biasa. Contoh:
Langkah 2. Pilih format output
MediaWiki menawarkan keluaran data dalam bentuk JSON, JSONFM, PHP (format berseri), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM, dan RAWFM. Format dengan akhiran "FM" cukup dicetak dalam HTML.
Langkah 3. Pilih tindakan
MediaWiki API mendukung tindakan berikut:
- bantuan - Lihat layar bantuan
- masuk - Masuk ke MediaWiki
- opensearch - Menerapkan protokol opensearch. (Tidak semua instalasi MediaWiki memiliki ini).
- feedwatchlist - Mengembalikan feed daftar pantauan.
- query - Memiliki berbagai pilihan. Lihat dokumentasi API MediaWiki untuk mereka.
Langkah 4. Pilih kueri atau daftar
Selain tindakan standar, MediaWiki mendukung kueri dan daftar yang berbeda, seperti halaman daftar yang berisi tautan ke artikel lain, jumlah perbedaan perubahan terbaru, kontribusi, dll.
Langkah 5. Lewati data yang diposting ke API melalui penggunaan CURL atau alat lain yang memungkinkan Anda menggunakan metode POST ke skrip
Metode GET juga dapat berfungsi.
Langkah 6. Pastikan untuk menyimpan cookie yang dikirim ke aplikasi (Beberapa skrip/aplikasi mungkin ingin menyimpannya dalam subfolder
Langkah 7. Saat berinteraksi dengan antarmuka pengguna MediaWiki, ingatlah bahwa token edit Anda disimpan di sebagian besar halaman edit
Token edit digunakan untuk menentukan tabrakan pengeditan dan menghindari menimpa pengeditan lain yang sudah dilakukan (Ini juga digunakan dalam rollback.). Ingatlah bahwa lebih mudah untuk melakukan kesalahan jika Anda bertindak dengan antarmuka pengguna wiki. Perhatikan setiap regex yang Anda gunakan untuk memastikan bahwa mereka hanya akan melakukan hasil yang diinginkan.
Langkah 8. Baca hasil yang dikirim oleh wiki
Hasilnya akan dikirimkan kepada Anda dalam respons HTTP, yang dapat dibaca oleh banyak parser. Berhati-hatilah dengan format yang Anda pilih. Pastikan Anda menggunakan parser yang sesuai untuk format tersebut. Biasanya merupakan praktik yang baik untuk secara eksplisit menyatakan format ke MediaWiki meskipun memiliki format default yang ingin Anda gunakan.
Tips
- Pastikan Anda memiliki dukungan skrip wiki lokal Anda sebelum menggunakan API.
- Anda dapat menemukan lebih banyak tentang MediaWiki dengan menggunakan API-nya.
