ממשק API של MediaWiki הוא קבוצה מתועדת של כלי פיתוח שיכולים לבצע את רוב המשימות בסקריפט אחד. ה- API משמש בדרך כלל לפיתוח כלים אוטומטיים לשימוש בויקי. ניתן להשתמש בקלות בממשק API של MediaWiki על ידי רוב השפות, במיוחד PHP (פונקציות התלתלים) כמו גם Perl ועוד כמה.
צעדים
שלב 1. קרא את תיעוד ה- API של MediaWiki
הוא ממוקם ב- 'api.php' באותה ספרייה כמו index.php הרגיל. דוגמה:
שלב 2. בחר תבנית פלט
MediaWiki מציע פלט נתונים בצורה של JSON, JSONFM, PHP (פורמט מסודר), PHPFM, WDDX, WDDXFM, XML, XMLFM, YAML, YAMLFM ו- RAWFM. הפורמטים המצורפים "FM" מודפסים יפה ב- HTML.
שלב 3. בחר פעולה
ממשק API של MediaWiki תומך בפעולות הבאות:
- עזרה - עיין במסך העזרה
- התחברות - התחברות ל- MediaWiki
- opensearch - יישום פרוטוקול opensearch. (לא לכל ההתקנות של MediaWiki יש את זה).
- רשימת צפייה - החזר עדכון של רשימת צפייה.
- שאילתה - יש מגוון אפשרויות. עיין בתיעוד ה- API של MediaWiki עבורם.
שלב 4. בחר שאילתה או רשימה
מלבד הפעולות הסטנדרטיות, MediaWiki תומך בשאילתות ורשימות שונות, כגון רישום דפי המכילים קישור למאמר אחר, מספר שינויים שונים לאחרונה, תרומות וכו '.
שלב 5. העבר את הנתונים שפורסמו ל- API באמצעות CURL או כלי אחר המאפשר לך להשתמש בשיטת POST לתסריט
שיטת GET עשויה גם לפעול.
שלב 6. הקפד לשמור קובצי Cookie שנשלחים ליישום (סקריפטים/יישומים מסוימים עשויים לרצות לאחסן אותם בתיקיית משנה
שלב 7. בעת אינטראקציה עם ממשק המשתמש של MediaWiki, שים לב לאסימון העריכה שלך שנשמר ברוב דפי העריכה
אסימון העריכה משמש לקביעת התנגשויות עריכה והימנעות מעקיפת עריכה נוספת שכבר בוצעה (זה משמש גם בהחזרה). זכור כי קל יותר לדברים להשתבש אם אתה פועל עם ממשק המשתמש של הוויקי. שים לב לכל הפקודות הרגילות שבהן אתה משתמש כדי לוודא שהן יעשו רק את התוצאה המיועדת.
שלב 8. קרא את התוצאות שנשלחו על ידי הוויקי
התוצאות יישלחו אליך בתגובת HTTP, הניתנת לקריאה של מנתחים רבים. הקפד במיוחד על הפורמט שאתה בוחר. הקפד להשתמש בנתח המתאים לפורמט זה. בדרך כלל נהוג לציין במפורש את הפורמט ל- MediaWiki גם אם יש לו פורמט ברירת מחדל שאתה רוצה להשתמש בו.
טיפים
- ודא שיש לך את התמיכה של הוויקי המקומי שלך בסקריפט לפני השימוש ב- API.
- תוכל למצוא מידע נוסף על MediaWiki באמצעות ה- API שלה.
