עזרה של MediaWiki API
זהו דף תיעוד של API שנוצר באופן אוטומטי.
תיעוד ודוגמאות: https://www.mediawiki.org/wiki/API
action=opensearch
(main | opensearch)
- יחידה זו דורשת הרשאות קריאה.
- מקור: MediaWiki
- רישיון: GPL-2.0+
חיפוש בוויקי בפרוטוקול OpenSearch.
פרמטרים:
- search
מחרוזת לחיפוש.
- limit
המספר המרבי של התוצאות שתוחזרנה.
- המספר המרבי המותר הוא 100 (עבור בוטים – 100).
- סוג: מספר שלם או max
- ברירת מחדל: 10
- namespace
שמות מתחם לחיפוש.
- ערכים (מופרדים באמצעות "|"): 0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15
- ברירת מחדל: 0
- suggest
לא לעשות דבר אם $wgEnableOpenSearchSuggest הוא false.
- סוג: בוליאני (פרטים)
- redirects
איך לטפל בהפניות:
- return
- להחזיר את ההפניה עצמה.
- resolve
- להחזיר את דף היעד. יכול להחזיר פחות מ־limit תוצאות.
מסיבות היסטוריות, בררת המחדל היא "return" עבור format=json ו־"resolve" עבור תסדירים אחרים.
- אחד מהערכים הבאים: return, resolve
- format
תסדיר הפלט.
- אחד מהערכים הבאים: json, jsonfm, xml, xmlfm
- ברירת מחדל: json
- warningsaserror
אם אזהרות מוּעלות עם format=json, להחזיר שגיאת API במקום להתעלם מהן.
- סוג: בוליאני (פרטים)
דוגמה:
- חיפוש דפים שמתחילים ב־Te.
- api.php?action=opensearch&search=Te