עזרה של MediaWiki API

זהו דף תיעוד של API שנוצר באופן אוטומטי.

תיעוד ודוגמאות: https://www.mediawiki.org/wiki/API

יחידה ראשית

  • מקור: MediaWiki
  • רישיון: GPL-2.0+

מצב: כל האפשרויות שמוצגות בדף הזה אמורות לעבוד, אבל ה־API עדיין בפיתוח פעיל, ויכול להשתנות בכל זמן. עשו מינוי ל רשימת הדיוור mediawiki-api-announce להודעות על עדכונים.

בקשות שגויות: כשבקשות שגויות נשלחות ל־API, תישלח כותרת HTTP עם המפתח "MediaWiki-API-Error" ואז גם הערך של הכותרת וגם קוד השגיאה יוגדרו לאותו ערך. למידע נוסף ר' API: שגיאות ואזהרות.

פרמטרים:
action

איזו פעולה לבצע.

אחד מהערכים הבאים: block, checktoken, clearhasmsg, compare, createaccount, delete, edit, emailuser, expandtemplates, feedcontributions, feedrecentchanges, feedwatchlist, filerevert, help, imagerotate, import, login, logout, managetags, move, opensearch, options, paraminfo, parse, patrol, protect, purge, query, revisiondelete, rollback, rsd, setnotificationtimestamp, stashedit, tag, tokens, unblock, undelete, upload, userrights, watch
ברירת מחדל: help
format

תסדיר הפלט.

אחד מהערכים הבאים: dbg, dbgfm, json, jsonfm, none, php, phpfm, rawfm, txt, txtfm, xml, xmlfm, yaml, yamlfm
ברירת מחדל: jsonfm
maxlag

שיהוי מרבי יכול לשמש כשמדיה־ויקי מותקנת בצביר עם מסד נתונים משוכפל. כדי לחסוך בפעולות שגורמות יותר שיהוי בשכפול אתר, הפרמטר הזה יכול לגרום ללקוח להמתין עד ששיהוי השכפול יורד מתחת לערך שצוין. במקרה של שיהוי מוגזם, קוד השגיאה maxlag מוחזר עם הודעה כמו Waiting for $host: $lag seconds lagged.
ר' מדריך למשתמש: פרמטר maxlag למידע נוסף.

סוג: מספר שלם
smaxage

הגדרת כותרת בקרת מטמון HTTP‏ s-maxage למספר כזה של שניות.

סוג: מספר שלם
ברירת מחדל: 0
maxage

הגדרת כותרת בקרת מטמון HTTP‏ max-age למספר כזה של שניות.

סוג: מספר שלם
ברירת מחדל: 0
assert

לוודא שהמשתמש נכנס אם זה מוגדר ל־user, או שיש לו הרשאת בוט אם זה bot.

אחד מהערכים הבאים: user, bot
requestid

כל ערך שיינתן כאן ייכלל בתשובה. אפשר להשתמש בזה כדי להבדיל בין בקשות.

servedby

לכלול את שם המארח ששירת את הבקשה בתוצאות.

סוג: בוליאני (פרטים)
curtimestamp

הכללת חותם־הזמן הנוכחי בתוצאה.

סוג: בוליאני (פרטים)
origin

בעת גישה ל־API עם בקשת AJAX חוצה מתחמים (CORS), יש להציב כאן את המתחם שהבקשה יוצאת ממנו. זה היה להיות כלול בכל בקשה מקדימה, ולכן הוא חייב להיות חלק מה־URI של הבקשה (לא גוף ה־POST). זה חייב להיות תואם במדויק לאחד המקורות בכותרת Origin, כך שזה צריך להיות מוגדר למשהו כמו https://en.wikipedia.org או https://meta.wikimedia.org. אם הפרמטר הזה אינו תואם לכותרת Origin, תוחזר תשובת 403. אם הפרמטר הזה תורם לכותרת Origin והמקור נמצא ברשימה הלבנה, תוגדר כותרת Access-Control-Allow-Origin.

uselang

באיזו שפה להשתמש לתרגומי הודעות. אפשר לקבל רשימת קודים מ־action=query&meta=siteinfo עם siprop=languages או לציין user כדי להשתמש בהעדפת השפה של המשתמש הנוכחי, או להגדיר את content להשתמש בקוד השפה של הוויקי הזה.

ברירת מחדל: user
דוגמאות:
עזרה ליחידה הראשית.
api.php?action=help
כל העזרה בדף אחד.
api.php?action=help&recursivesubmodules=1
הרשאות:
writeapi
שימוש ב־API לשינוי דפים
הוענקו ל: all, user, bot
apihighlimits
להשתמש במגבלות גבוהות יותר בשאילתות API (שאילתות אטיות: 500; שאילתות מהירות: 5000). המגבלות לשאילתות אטיות חלות גם על פרמטרים מרובי־ערכים.
הוענקו ל: bot, sysop

סוגי נתונים

חלק מסוגי הפרמטרים בבקשות API דורשים הסבר נוסף:

בוליאני (boolean)
פרמטרים בוליאניים עובדים כמו תיבות סימון של HTML: אם הפרמטר צוין, בלי קשר לערך שלו, הוא אמת (true). בשביל ערך שקר (false), יש להשמיט את הפרמטר לגמרי.
חותם־זמן (timestamp)
אפשר לכתוב חותמי־זמן במספר תסדירים. תאריך ושעה לפי ISO 8601 הוא הדבר המומלת. כל הזמנים מצוינים ב־ UTC, לא תהיה השפעה לשום אזור זמן שיצוין.
  • תאריך ושעה לפי ISO 8601‏, 2001-01-15T14:56:00Z (לא חובה לכתוב פיסוק ו־Z)
  • תאריך ושעה לפי ISO 8601 עם חלקי שנייה (שלא תהיה להם שום השפעה), 2001-01-15T14:56:00.00001Z (לא חובה לכתוב קווים מפרידים, נקודתיים ו־Z)
  • תסדיר MediaWiki‏, 20010115145600
  • תסדיר מספרי כללי, 2001-01-15 14:56:00 (לאזור זמן אופציונלי של GMT‏, +##, או -## אין השפעה)
  • תסדיר EXIF‏, 2001:01:15 14:56:00
  • תסדיר RFC 2822 (אפשר להשמיט את אזור הזמן), Mon, 15 Jan 2001 14:56:00
  • תסדיר RFC 850 (אפשר להשמיט את אזור הזמן), Monday, 15-Jan-2001 14:56:00
  • תסדיר C ctime‏, Mon Jan 15 14:56:00 2001
  • שניות מאז 1970-01-01T00:00:00Z בתור מספר שלך בין 1 ל־13 (לא כולל 0)
  • המחרוזת now

קרדיטים

מפתחי ה־API:

  • רואן קטאו (מפתח מוביל 2007–2009)
  • ויקטור וסילייב
  • בריאן טונג מין
  • סאם ריד
  • יורי אסטרחן (יוצר, מפתח מוביל מספטמבר 2006 עד ספטמבר 2007)
  • בראד יורש (מפתח מוביל מאז 2013)

אנא שלחו הערות, הצעות ושאלות לכתובת [email protected] או כתבו דיווח באג באתר https://phabricator.wikimedia.org.

מקור: http://parawiki.yuvdi.com/מיוחד:עזרת_API