API:מאפיינים
Appearance
דף זה הוא חלק מהתיעוד של ה־action API של מדיה־ויקי |
בקשת GET על מנת להכין רשימה של מאפיינים של דפים מסוימים.
תיעוד API
מאפיינים הם נתונים אודות דף כלשהו, למשל קטגוריות, או תוכן של דף, למשל תמונות או קישורים.
על מנת לבקש מאפיין יש לשלוח דרך הפרמטר prop
של השאילתא מאפיין תקין, שתואם למידע שברצונכם לקבל.
את הדף או הדפים שעבורם רוצים לקבל את הנתונים יש לציין בפרמטרים titles
, pageids
או revids
של השאילתא, או דרך גנרטור .
שאילתות של מאפיינים נכתבות בערך כך: action=query&titles=title1&prop=property1|property2
.
שאילתות של מאפיינים כוללים תמיד מגבלה על כמות הפריטים שמוחזרים.
כדי לקבל פריטים נוספים, יש לצרף את הערכים שבתוך האלמנט continue
של התשובה לתוך הבקשה הראשונה.
ניתן למצוא דוגמאות מדויקות אודות אופן השימוש במאפיינים בדפי ה־API המתאימים:
הערות נוספות
- רוב תת־המודולים שמתייחסים למאפיינים יכולים לשמש גם בתור גנרטורים , אלא אם כן מצויין אחרת.
- מגבלות על שאילתות מאפיינים:
- תוצאות של שאילתות מאפיינים תמיד כוללים מגבלה כלשהי; מגבלת ברירת־המחדל היא 10. ניתן לשנות את המגבלה על מספר הפריטים בתוצאה ל־500 עבור משתמשים רגילים, או 5000 עבור משתמשים שמחזיקים בהרשאה
apihighlimits
(בדרך כלל בוטים ומפעילי מערכת). חלק מהמודולים כופים מגבלות קפדניות יותר תחת תנאים מסוימים. - אם אתם לא בטוחים איזו מגבלה חלה עליכם ואתם רק רוצים כמה תוצאות שניתן, יש לקבוע את המגבלה ל־
max
. במקרה זה, האלמנטlimits
יוחזר, כאשר הוא מציין את המגבלות שבהן השתמשו.
- תוצאות של שאילתות מאפיינים תמיד כוללים מגבלה כלשהי; מגבלת ברירת־המחדל היא 10. ניתן לשנות את המגבלה על מספר הפריטים בתוצאה ל־500 עבור משתמשים רגילים, או 5000 עבור משתמשים שמחזיקים בהרשאה
- The limit parameter for a given module consists of the module prefix followed by the word
limit
.
- The limit parameter for a given module consists of the module prefix followed by the word
לדוגמה, imlimit
הוא המספר המרבי של images
שמוחזרים.
ר' גם
- Documentation on query module - contains a brief description of all property submodules, their corresponding parameters, and values.
- API:Database field and API property associations - contains a table describing how query properties are associated with the fields in a MediaWiki database .
- API:Lists - a similar API, for accessing lists of information, such as
allusers
, orrecentchanges
. Unlike property queries, which append data to thepages
element, lists return a separate branch in thequery
element.
- Maintained by MediaWiki Interfaces Team.
- Live chat (IRC): #mediawiki-core connect
- Issue tracker: Phabricator MediaWiki-Action-API (Report an issue)