Το API MediaWiki είναι ένα καλά τεκμηριωμένο σύνολο εργαλείων ανάπτυξης που μπορούν να εκτελέσουν τις περισσότερες εργασίες σε ένα σενάριο. Το API χρησιμοποιείται συνήθως για την ανάπτυξη αυτοματοποιημένων εργαλείων για χρήση στο wiki. Το MediaWiki API μπορεί να χρησιμοποιηθεί εύκολα από τις περισσότερες γλώσσες, ιδιαίτερα την PHP (Οι λειτουργίες κουρδίσματος) καθώς και το Perl και μερικές άλλες.
Βήματα
Βήμα 1. Διαβάστε την τεκμηρίωση του MediaWiki API
Βρίσκεται στο 'api.php' στον ίδιο κατάλογο με το συνηθισμένο index.php. Παράδειγμα:
Βήμα 2. Επιλέξτε μια μορφή εξόδου
Το MediaWiki προσφέρει έξοδο δεδομένων με τη μορφή JSON, JSONFM, PHP (σειριακή μορφή), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM και RAWFM. Οι μορφές με επίθεμα "FM" είναι αρκετά τυπωμένες σε HTML.
Βήμα 3. Επιλέξτε μια ενέργεια
Το API MediaWiki υποστηρίζει τις ακόλουθες ενέργειες:
- βοήθεια - Δείτε την οθόνη βοήθειας
- login - Συνδεθείτε στο MediaWiki
- opensearch - Εφαρμόστε το πρωτόκολλο opensearch. (Δεν το έχουν όλες οι εγκαταστάσεις του MediaWiki).
- λίστα τροφοδοσίας - Επιστροφή ροής λίστας παρακολούθησης.
- ερώτημα - Έχει μια ποικιλία επιλογών. Δείτε την τεκμηρίωση του MediaWiki API για αυτούς.
Βήμα 4. Επιλέξτε ένα ερώτημα ή μια λίστα
Εκτός από τις τυπικές ενέργειες, το MediaWiki υποστηρίζει διαφορετικά ερωτήματα και λίστες, όπως σελίδες καταχώρισης που περιέχουν σύνδεσμο σε άλλο άρθρο, αριθμό πρόσφατων διαφορών αλλαγών, συνεισφορές κ.λπ.
Βήμα 5. Μεταφέρετε τα δημοσιευμένα δεδομένα στο API χρησιμοποιώντας CURL ή άλλο εργαλείο που σας επιτρέπει να χρησιμοποιήσετε τη μέθοδο POST στο σενάριο
Η μέθοδος GET μπορεί επίσης να λειτουργήσει.
Βήμα 6. Βεβαιωθείτε ότι έχετε αποθηκεύσει τα cookie σε μια εφαρμογή (Ορισμένα σενάρια/εφαρμογές μπορεί να επιθυμούν να την αποθηκεύσετε σε έναν υποφάκελο
Βήμα 7. Όταν αλληλεπιδράτε με τη διεπαφή χρήστη του MediaWiki, προσέξτε το διακριτικό επεξεργασίας που διατηρείται στις περισσότερες σελίδες επεξεργασίας
Το διακριτικό επεξεργασίας χρησιμοποιείται για τον προσδιορισμό των συγκρούσεων επεξεργασίας και την αποφυγή παράκαμψης μιας άλλης επεξεργασίας που έχει ήδη γίνει (Αυτό χρησιμοποιείται επίσης και στην επαναφορά). Λάβετε υπόψη ότι είναι ευκολότερο τα πράγματα να στραβώσουν εάν ενεργείτε με τη διεπαφή χρήστη του wiki. Έχετε υπόψη σας τυχόν regex που χρησιμοποιείτε για να βεβαιωθείτε ότι θα κάνουν μόνο το επιδιωκόμενο αποτέλεσμα.
Βήμα 8. Διαβάστε τα αποτελέσματα που στάλθηκαν από το wiki
Τα αποτελέσματα θα σας αποσταλούν σε μια απάντηση HTTP, η οποία μπορεί να διαβαστεί από πολλούς αναλυτές. Προσέξτε ιδιαίτερα τη μορφή που θα επιλέξετε. Βεβαιωθείτε ότι χρησιμοποιείτε τον κατάλληλο αναλυτή για αυτήν τη μορφή. Συνήθως είναι καλή πρακτική να δηλώνετε ρητά τη μορφή στο MediaWiki, ακόμη και αν έχει μια προεπιλεγμένη μορφή που θέλετε να χρησιμοποιήσετε.
Συμβουλές
- Βεβαιωθείτε ότι έχετε το τοπικό wiki που υποστηρίζει το σενάριο πριν χρησιμοποιήσετε το API.
- Μπορείτε να βρείτε περισσότερα σχετικά με το MediaWiki χρησιμοποιώντας το API του.
