راهنمای واسط برنامه‌نویسی کاربردی مدیاویکی
این یک صفحهٔ مستندات برای واسط برنامه‌نویسی کاربردی مدیاویکی است که به‌طور خودکار ایجاد شده‌است.
مستندات و نمونه‌ها: https://www.mediawiki.org/wiki/Special:MyLanguage/API:Main_page
action=opensearch
(main | opensearch)
- این پودمان نیازمند اختیارات خواندن است.
- منبع: MediaWiki
- مجوز: GPL-2.0-or-later
جستجو در ویکی بااستفاده از پروتکل اوپن‌سرچ.
پارامترها:
- search
جستجوی رشته.
- این پارامتر الزامی است.
- namespace
فضاهای نام برای جستجو. در صورتی که search با یک پیشوند فضای نام معتبر آغاز شود، از این مورد چشم‌پوشی می‌شود.
- مقدارهای (جداشده با | یا جایگزین‌های آن): 0، 1، 2، 3، 4، 5، 6، 7، 8، 9، 10، 11، 12، 13، 14، 15
- برای تعیین همهٔ مقدارها از * استفاده کنید.
- پیش‌فرض: 0
- limit
حداکثر تعداد نتایج برای بازگرداندن.
- نوع: عدد صحیح یا max
- The value must be between ۱ and ۵۰۰.
- پیش‌فرض: 10
- suggest
- منسوخ‌شده.
دیگر کاربرد ندارد.
- نوع: بولی (جزئیات)
- redirects
How to handle redirects:
- return
- Return the redirect itself.
- resolve
- Return the target page. May return fewer than limit results.
For historical reasons, the default is "return" for format=json and "resolve" for other formats.
- یکی از مقدارهای زیر: resolve، return
- format
فرمت خروجی.
- یکی از مقدارهای زیر: json، jsonfm، xml، xmlfm
- پیش‌فرض: json
- warningsaserror
If warnings are raised with format=json, return an API error instead of ignoring them.
- نوع: بولی (جزئیات)
نمونه:
- یافتن صفحه‌هایی که با Te آغاز می‌شوند
- api.php?action=opensearch&search=Te [باز کردن در صفحهٔ تمرین]