עזרה של MediaWiki API

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

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

list=prefixsearch (ps)

(main | query | prefixsearch)
  • יחידה זו דורשת הרשאות קריאה.
  • אפשר להשתמש ביחידה הזאת בתור מחולל.
  • מקור: MediaWiki
  • רישיון: GPL-2.0-or-later

ביצוע חיפוש תחילית של כותרות דפים.

למרות הדמיון בשם, המודול הזה אינו אמור להיות שווה ל־Special:PrefixIndex ("מיוחד:דפים המתחילים ב"); לדבר כזה, ר' action=query&list=allpages עם הפרמטר apprefix. מטרת המודול הזה דומה ל־action=opensearch: לקבל קלט ממשתמש ולספק את הכותרות המתאימות ביותר. בהתאם לשרת מנוע החיפוש, זה יכול לכלול תיקון שגיאות כתיב, הימנעות מדפי הפניה והירסטיקות אחרות.

פרמטרים:
pssearch

מחרוזת לחיפוש.

הפרמטר הזה נדרש.
psnamespace

מרחבי השם שבהם יתבצע החיפוש. לשדה זה אין משמעות אם pssearch מתחיל עם תחילית תקינה של מרחב שם.

ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 274, 275, 828, 829, 2300, 2301, 2302, 2303
כדי לתת את כל הערכים, יש להשתמש ב־*.
ברירת המחדל: 0
pslimit

מספר התוצאות המרבי להחזרה.

סוג: מספר שלם או max
הערך חייב להיות בין 1 ל־500.
ברירת המחדל: 10
psoffset

כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.

סוג: מספר שלם
ברירת המחדל: 0
דוגמה:
חיפוש שםות דפים שמתחילים ב־meaning.
api.php?action=query&list=prefixsearch&pssearch=meaning [פתיחה בארגז חול]