MediaWiki API adalah sekumpulan alat pengembangan yang didokumentasikan dengan baik yang dapat melakukan sebahagian besar tugas dalam satu skrip. API biasanya digunakan untuk pengembangan alat automatik untuk digunakan di wiki. API MediaWiki dapat digunakan dengan mudah oleh kebanyakan bahasa, terutamanya PHP (fungsi curl) serta Perl dan beberapa yang lain..
Langkah-langkah
Langkah 1. Baca dokumentasi MediaWiki API
Ia terletak di 'api.php' dalam direktori yang sama dengan index.php biasa. Contoh:
Langkah 2. Pilih format output
MediaWiki menawarkan output data dalam bentuk JSON, JSONFM, PHP (format bersiri), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM, dan RAWFM. Format yang diakhiri "FM" dicetak cantik dalam HTML.
Langkah 3. Pilih tindakan
API MediaWiki menyokong tindakan berikut:
- tolong - Lihat skrin bantuan
- log masuk - Log masuk ke MediaWiki
- opensearch - Melaksanakan protokol opensearch. (Tidak semua pemasangan MediaWiki memilikinya).
- feedwatchlist - Mengembalikan suapan senarai pantau.
- pertanyaan - Mempunyai pelbagai pilihan. Lihat dokumentasi API MediaWiki untuk mereka.
Langkah 4. Pilih pertanyaan atau senarai
Selain tindakan biasa, MediaWiki menyokong pertanyaan dan senarai yang berbeza, seperti menyenaraikan halaman yang mengandungi pautan ke artikel lain, jumlah perubahan terkini, sumbangan, dll.
Langkah 5. Kirimkan data yang diposkan ke API melalui penggunaan CURL atau alat lain yang membolehkan anda menggunakan kaedah POST ke skrip
Kaedah GET juga boleh berfungsi.
Langkah 6. Pastikan kuki dihantar ke aplikasi (Beberapa skrip / aplikasi mungkin ingin menyimpannya dalam subfolder
Langkah 7. Semasa berinteraksi dengan antara muka pengguna MediaWiki, ingat token edit anda yang tersimpan di kebanyakan halaman edit
Token suntingan digunakan untuk menentukan perlanggaran pengeditan dan mengelakkan penindasan yang lain yang sudah dilakukan (Ini juga digunakan dalam rollback juga.). Perlu diingat bahawa lebih mudah bagi sesuatu yang tidak beres jika anda bertindak dengan antara muka pengguna wiki. Berhati-hatilah dengan setiap regex yang anda gunakan untuk memastikan bahawa mereka hanya akan menghasilkan hasil yang diharapkan.
Langkah 8. Baca hasil yang dihantar oleh wiki
Hasilnya akan dikirimkan kepada anda dalam respons HTTP, yang dapat dibaca oleh banyak penghurai. Berhati-hati dengan format yang anda pilih. Pastikan anda menggunakan penghurai yang sesuai untuk format itu. Biasanya adalah amalan yang baik untuk menyatakan format secara eksplisit kepada MediaWiki walaupun mempunyai format lalai yang ingin anda gunakan.
Petua
- Pastikan anda mempunyai sokongan skrip wiki tempatan anda sebelum menggunakan API.
- Anda boleh mengetahui lebih lanjut mengenai MediaWiki dengan menggunakan API-nya.
