עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/API
list=allpages (ap)
- יחידה זו דורשת הרשאות קריאה.
- אפשר להשתמש ביחידה הזאת בתור מחולל.
- מקור: MediaWiki
- רישיון: GPL-2.0-or-later
למנות את כל הדפים לפי הסדר במרחב שם נתון.
פרמטרים:
- apfrom
מאיזה שם דף להתחיל למנות.
- apcontinue
כשיש עוד תוצאות, להשתמש בזה בשביל להמשיך.
- apto
כותרת הדף שהמנייה תסתיים בו.
- apprefix
חיפוש כל שמות הדפים שמתחילים בערך הזה.
- apnamespace
איזה מרחב שם למנות.
- אחד מהערכים הבאים: 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 100, 101, 102, 103, 274, 275
- ברירת מחדל: 0
- apfilterredir
אילו דפים לרשום.
- אחד מהערכים הבאים: all, redirects, nonredirects
- ברירת מחדל: all
- apminsize
להגביל לדפים עם מספר כזה לפחות של בייטים.
- סוג: מספר שלם
- apmaxsize
להגביל לדפים שיש בהם לכל היותר מספר כזה של בייטים.
- סוג: מספר שלם
- apprtype
להגביל רק לדפים מוגנים.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): edit, move, upload
- apprlevel
לסנו הגנות לפי רמת ההגנה (חייב לשמש עם apprtype= parameter).
- ערכים (מופרדים באמצעות "|" או or תו חלופי): יכול להיות ריק או autoconfirmed, sysop
- apprfiltercascade
לסנן הגנות לפי דירוגיות (לא תקף כאשר apprtype אינו מוגדר).
- אחד מהערכים הבאים: cascading, noncascading, all
- ברירת מחדל: all
- aplimit
כמה דפים להחזיר בסך הכול.
- המספר המרבי המותר הוא 500 (עבור בוטים – 5,000).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- apdir
באיזה כיוון לרשום.
- אחד מהערכים הבאים: ascending, descending
- ברירת מחדל: ascending
- apfilterlanglinks
סינון על סמך קיום קישורים לשוניים בדף. יש לשים לב לכך שזה אולי לא יתייחס לקישורים לשוניים שנוספו על־ידי הרחבות.
- אחד מהערכים הבאים: withlanglinks, withoutlanglinks, all
- ברירת מחדל: all
- apprexpiry
לפי איזו תפוגת הגנה לסנן את הדף הזה:
- indefinite
- לקבל רק דפים מוגנית לצמיתות.
- definite
- לקבל רק דפים עם תפוגת הגנה מוגדרת.
- all
- לקבל דפים עם תפוגת הגנה כלשהי.
- אחד מהערכים הבאים: indefinite, definite, all
- ברירת מחדל: all
דוגמאות:
- להציג רשימה של דפים במתחילים באות B.
- api.php?action=query&list=allpages&apfrom=B [פתיחה בארגז חול]
- להציג מידע על 4 דפים שמתחילים באות T.
- api.php?action=query&generator=allpages&gaplimit=4&gapfrom=T&prop=info [פתיחה בארגז חול]
- להציג את תוכן של 2 הדפים הראשונים שמתחילים ב־Re ושאינם דפי הפניה.
- api.php?action=query&generator=allpages&gaplimit=2&gapfilterredir=nonredirects&gapfrom=Re&prop=revisions&rvprop=content [פתיחה בארגז חול]