עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=opensearch
(main | opensearch)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0-or-later
חיפוש בוויקי בפרוטוקול OpenSearch.
פרמטרים:
- search
מחרוזת לחיפוש.
- הפרמטר הזה נדרש.
- namespace
מרחבי השם שבהם יתבצע החיפוש. לשדה זה אין משמעות אם search מתחיל עם תחילית תקינה של מרחב שם.
- ערכים (מופרדים באמצעות "|" או or תו חלופי): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 102, 103, 106, 107, 108, 109, 112, 113, 114, 115, 274, 275, 2300, 2301, 2302, 2303
- כדי לתת את כל הערכים, יש להשתמש ב־*.
- ברירת המחדל: 0
- limit
המספר המרבי של התוצאות שתוחזרנה.
- סוג: מספר שלם או max
- הערך חייב להיות בין 1 ל־500.
- ברירת המחדל: 10
- suggest
- מיושן.
כבר לא בשימוש.
- סוג: בוליאני (פרטים)
- redirects
איך לטפל בהפניות:
- return
- להחזיר את ההפניה עצמה.
- resolve
- להחזיר את דף היעד. יכול להחזיר פחות מ־limit תוצאות.
מסיבות היסטוריות, ברירת המחדל היא "return" עבור format=json ו־"resolve" עבור תסדירים אחרים.
- אחד מהערכים הבאים: resolve, return
- format
תסדיר הפלט.
- אחד מהערכים הבאים: json, jsonfm, xml, xmlfm
- ברירת המחדל: json
- warningsaserror
אם אזהרות מוּעלות עם format=json, להחזיר שגיאת API במקום להתעלם מהן.
- סוג: בוליאני (פרטים)
דוגמה:
- חיפוש דפים שמתחילים ב־Te.
- api.php?action=opensearch&search=Te [פתיחה בארגז חול]